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">
343 sFlow(R) configuration.
346 <column name="ipfix">
350 <column name="flood_vlans">
352 VLAN IDs of VLANs on which MAC address learning should be disabled,
353 so that packets are flooded instead of being sent to specific ports
354 that are believed to contain packets' destination MACs. This should
355 ordinarily be used to disable MAC learning on VLANs used for
356 mirroring (RSPAN VLANs). It may also be useful for debugging.
359 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
360 the <ref table="Port"/> table) is incompatible with
361 <code>flood_vlans</code>. Consider using another bonding mode or
362 a different type of mirror instead.
367 <group title="OpenFlow Configuration">
368 <column name="controller">
370 OpenFlow controller set. If unset, then no OpenFlow controllers
375 If there are primary controllers, removing all of them clears the
376 flow table. If there are no primary controllers, adding one also
377 clears the flow table. Other changes to the set of controllers, such
378 as adding or removing a service controller, adding another primary
379 controller to supplement an existing primary controller, or removing
380 only one of two primary controllers, have no effect on the flow
385 <column name="flow_tables">
386 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
387 table ID to configuration for that table.
390 <column name="fail_mode">
391 <p>When a controller is configured, it is, ordinarily, responsible
392 for setting up all flows on the switch. Thus, if the connection to
393 the controller fails, no new network connections can be set up.
394 If the connection to the controller stays down long enough,
395 no packets can pass through the switch at all. This setting
396 determines the switch's response to such a situation. It may be set
397 to one of the following:
399 <dt><code>standalone</code></dt>
400 <dd>If no message is received from the controller for three
401 times the inactivity probe interval
402 (see <ref column="inactivity_probe"/>), then Open vSwitch
403 will take over responsibility for setting up flows. In
404 this mode, Open vSwitch causes the bridge to act like an
405 ordinary MAC-learning switch. Open vSwitch will continue
406 to retry connecting to the controller in the background
407 and, when the connection succeeds, it will discontinue its
408 standalone behavior.</dd>
409 <dt><code>secure</code></dt>
410 <dd>Open vSwitch will not set up flows on its own when the
411 controller connection fails or when no controllers are
412 defined. The bridge will continue to retry connecting to
413 any defined controllers forever.</dd>
417 The default is <code>standalone</code> if the value is unset, but
418 future versions of Open vSwitch may change the default.
421 The <code>standalone</code> mode can create forwarding loops on a
422 bridge that has more than one uplink port unless STP is enabled. To
423 avoid loops on such a bridge, configure <code>secure</code> mode or
424 enable STP (see <ref column="stp_enable"/>).
426 <p>When more than one controller is configured,
427 <ref column="fail_mode"/> is considered only when none of the
428 configured controllers can be contacted.</p>
430 Changing <ref column="fail_mode"/> when no primary controllers are
431 configured clears the flow table.
435 <column name="datapath_id">
436 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
437 (Setting this column has no useful effect. Set <ref
438 column="other-config" key="datapath-id"/> instead.)
441 <column name="other_config" key="datapath-id">
442 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
443 value. May not be all-zero.
446 <column name="other_config" key="dp-desc">
447 Human readable description of datapath. It it a maximum 256
448 byte-long free-form string to describe the datapath for
449 debugging purposes, e.g. <code>switch3 in room 3120</code>.
452 <column name="other_config" key="disable-in-band"
453 type='{"type": "boolean"}'>
454 If set to <code>true</code>, disable in-band control on the bridge
455 regardless of controller and manager settings.
458 <column name="other_config" key="in-band-queue"
459 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
460 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
461 that will be used by flows set up by in-band control on this bridge.
462 If unset, or if the port used by an in-band control flow does not have
463 QoS configured, or if the port does not have a queue with the specified
464 ID, the default queue is used instead.
467 <column name="protocols">
468 List of OpenFlow protocols that may be used when negotiating a
469 connection with a controller. A default value of
470 <code>OpenFlow10</code> will be used if this column is empty.
474 <group title="Spanning Tree Configuration">
475 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
476 that ensures loop-free topologies. It allows redundant links to
477 be included in the network to provide automatic backup paths if
478 the active links fails.
480 <column name="stp_enable">
481 Enable spanning tree on the bridge. By default, STP is disabled
482 on bridges. Bond, internal, and mirror ports are not supported
483 and will not participate in the spanning tree.
486 <column name="other_config" key="stp-system-id">
487 The bridge's STP identifier (the lower 48 bits of the bridge-id)
489 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
490 By default, the identifier is the MAC address of the bridge.
493 <column name="other_config" key="stp-priority"
494 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
495 The bridge's relative priority value for determining the root
496 bridge (the upper 16 bits of the bridge-id). A bridge with the
497 lowest bridge-id is elected the root. By default, the priority
501 <column name="other_config" key="stp-hello-time"
502 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
503 The interval between transmissions of hello messages by
504 designated ports, in seconds. By default the hello interval is
508 <column name="other_config" key="stp-max-age"
509 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
510 The maximum age of the information transmitted by the bridge
511 when it is the root bridge, in seconds. By default, the maximum
515 <column name="other_config" key="stp-forward-delay"
516 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
517 The delay to wait between transitioning root and designated
518 ports to <code>forwarding</code>, in seconds. By default, the
519 forwarding delay is 15 seconds.
523 <group title="Other Features">
524 <column name="datapath_type">
525 Name of datapath provider. The kernel datapath has
526 type <code>system</code>. The userspace datapath has
527 type <code>netdev</code>.
530 <column name="external_ids" key="bridge-id">
531 A unique identifier of the bridge. On Citrix XenServer this will
532 commonly be the same as
533 <ref column="external_ids" key="xs-network-uuids"/>.
536 <column name="external_ids" key="xs-network-uuids">
537 Semicolon-delimited set of universally unique identifier(s) for the
538 network with which this bridge is associated on a Citrix XenServer
539 host. The network identifiers are RFC 4122 UUIDs as displayed by,
540 e.g., <code>xe network-list</code>.
543 <column name="other_config" key="hwaddr">
544 An Ethernet address in the form
545 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
546 to set the hardware address of the local port and influence the
550 <column name="other_config" key="flow-eviction-threshold"
551 type='{"type": "integer", "minInteger": 0}'>
553 A number of flows as a nonnegative integer. This sets number of
554 flows at which eviction from the kernel flow table will be triggered.
555 If there are a large number of flows then increasing this value to
556 around the number of flows present can result in reduced CPU usage
560 The default is 1000. Values below 100 will be rounded up to 100.
564 <column name="other_config" key="forward-bpdu"
565 type='{"type": "boolean"}'>
566 Option to allow forwarding of BPDU frames when NORMAL action is
567 invoked. Frames with reserved Ethernet addresses (e.g. STP
568 BPDU) will be forwarded when this option is enabled and the
569 switch is not providing that functionality. If STP is enabled
570 on the port, STP BPDUs will never be forwarded. If the Open
571 vSwitch bridge is used to connect different Ethernet networks,
572 and if Open vSwitch node does not run STP, then this option
573 should be enabled. Default is disabled, set to
574 <code>true</code> to enable.
576 The following destination MAC addresss will not be forwarded when this
579 <dt><code>01:80:c2:00:00:00</code></dt>
580 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
582 <dt><code>01:80:c2:00:00:01</code></dt>
583 <dd>IEEE Pause frame.</dd>
585 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
586 <dd>Other reserved protocols.</dd>
588 <dt><code>00:e0:2b:00:00:00</code></dt>
589 <dd>Extreme Discovery Protocol (EDP).</dd>
592 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
594 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
596 <dt><code>01:00:0c:cc:cc:cc</code></dt>
598 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
599 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
603 <dt><code>01:00:0c:cc:cc:cd</code></dt>
604 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
606 <dt><code>01:00:0c:cd:cd:cd</code></dt>
607 <dd>Cisco STP Uplink Fast.</dd>
609 <dt><code>01:00:0c:00:00:00</code></dt>
610 <dd>Cisco Inter Switch Link.</dd>
612 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
617 <column name="other_config" key="mac-aging-time"
618 type='{"type": "integer", "minInteger": 1}'>
620 The maximum number of seconds to retain a MAC learning entry for
621 which no packets have been seen. The default is currently 300
622 seconds (5 minutes). The value, if specified, is forced into a
623 reasonable range, currently 15 to 3600 seconds.
627 A short MAC aging time allows a network to more quickly detect that a
628 host is no longer connected to a switch port. However, it also makes
629 it more likely that packets will be flooded unnecessarily, when they
630 are addressed to a connected host that rarely transmits packets. To
631 reduce the incidence of unnecessary flooding, use a MAC aging time
632 longer than the maximum interval at which a host will ordinarily
637 <column name="other_config" key="mac-table-size"
638 type='{"type": "integer", "minInteger": 1}'>
640 The maximum number of MAC addresses to learn. The default is
641 currently 2048. The value, if specified, is forced into a reasonable
642 range, currently 10 to 1,000,000.
647 <group title="Bridge Status">
649 Status information about bridges.
651 <column name="status">
652 Key-value pairs that report bridge status.
654 <column name="status" key="stp_bridge_id">
656 The bridge-id (in hex) used in spanning tree advertisements.
657 Configuring the bridge-id is described in the
658 <code>stp-system-id</code> and <code>stp-priority</code> keys
659 of the <code>other_config</code> section earlier.
662 <column name="status" key="stp_designated_root">
664 The designated root (in hex) for this spanning tree.
667 <column name="status" key="stp_root_path_cost">
669 The path cost of reaching the designated bridge. A lower
675 <group title="Common Columns">
676 The overall purpose of these columns is described under <code>Common
677 Columns</code> at the beginning of this document.
679 <column name="other_config"/>
680 <column name="external_ids"/>
684 <table name="Port" table="Port or bond configuration.">
685 <p>A port within a <ref table="Bridge"/>.</p>
686 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
687 <ref column="interfaces"/> column. Such a port logically
688 corresponds to a port on a physical Ethernet switch. A port
689 with more than one interface is a ``bonded port'' (see
690 <ref group="Bonding Configuration"/>).</p>
691 <p>Some properties that one might think as belonging to a port are actually
692 part of the port's <ref table="Interface"/> members.</p>
695 Port name. Should be alphanumeric and no more than about 8
696 bytes long. May be the same as the interface name, for
697 non-bonded ports. Must otherwise be unique among the names of
698 ports, interfaces, and bridges on a host.
701 <column name="interfaces">
702 The port's interfaces. If there is more than one, this is a
706 <group title="VLAN Configuration">
707 <p>Bridge ports support the following types of VLAN configuration:</p>
712 A trunk port carries packets on one or more specified VLANs
713 specified in the <ref column="trunks"/> column (often, on every
714 VLAN). A packet that ingresses on a trunk port is in the VLAN
715 specified in its 802.1Q header, or VLAN 0 if the packet has no
716 802.1Q header. A packet that egresses through a trunk port will
717 have an 802.1Q header if it has a nonzero VLAN ID.
721 Any packet that ingresses on a trunk port tagged with a VLAN that
722 the port does not trunk is dropped.
729 An access port carries packets on exactly one VLAN specified in the
730 <ref column="tag"/> column. Packets egressing on an access port
731 have no 802.1Q header.
735 Any packet with an 802.1Q header with a nonzero VLAN ID that
736 ingresses on an access port is dropped, regardless of whether the
737 VLAN ID in the header is the access port's VLAN ID.
741 <dt>native-tagged</dt>
743 A native-tagged port resembles a trunk port, with the exception that
744 a packet without an 802.1Q header that ingresses on a native-tagged
745 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
749 <dt>native-untagged</dt>
751 A native-untagged port resembles a native-tagged port, with the
752 exception that a packet that egresses on a native-untagged port in
753 the native VLAN will not have an 802.1Q header.
757 A packet will only egress through bridge ports that carry the VLAN of
758 the packet, as described by the rules above.
761 <column name="vlan_mode">
763 The VLAN mode of the port, as described above. When this column is
764 empty, a default mode is selected as follows:
768 If <ref column="tag"/> contains a value, the port is an access
769 port. The <ref column="trunks"/> column should be empty.
772 Otherwise, the port is a trunk port. The <ref column="trunks"/>
773 column value is honored if it is present.
780 For an access port, the port's implicitly tagged VLAN. For a
781 native-tagged or native-untagged port, the port's native VLAN. Must
782 be empty if this is a trunk port.
786 <column name="trunks">
788 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
789 or VLANs that this port trunks; if it is empty, then the port trunks
790 all VLANs. Must be empty if this is an access port.
793 A native-tagged or native-untagged port always trunks its native
794 VLAN, regardless of whether <ref column="trunks"/> includes that
799 <column name="other_config" key="priority-tags"
800 type='{"type": "boolean"}'>
802 An 802.1Q header contains two important pieces of information: a VLAN
803 ID and a priority. A frame with a zero VLAN ID, called a
804 ``priority-tagged'' frame, is supposed to be treated the same way as
805 a frame without an 802.1Q header at all (except for the priority).
809 However, some network elements ignore any frame that has 802.1Q
810 header at all, even when the VLAN ID is zero. Therefore, by default
811 Open vSwitch does not output priority-tagged frames, instead omitting
812 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
813 <code>true</code> to enable priority-tagged frames on a port.
817 Regardless of this setting, Open vSwitch omits the 802.1Q header on
818 output if both the VLAN ID and priority would be zero.
822 All frames output to native-tagged ports have a nonzero VLAN ID, so
823 this setting is not meaningful on native-tagged ports.
828 <group title="Bonding Configuration">
829 <p>A port that has more than one interface is a ``bonded port.'' Bonding
830 allows for load balancing and fail-over.</p>
833 The following types of bonding will work with any kind of upstream
834 switch. On the upstream switch, do not configure the interfaces as a
839 <dt><code>balance-slb</code></dt>
841 Balances flows among slaves based on source MAC address and output
842 VLAN, with periodic rebalancing as traffic patterns change.
845 <dt><code>active-backup</code></dt>
847 Assigns all flows to one slave, failing over to a backup slave when
848 the active slave is disabled. This is the only bonding mode in which
849 interfaces may be plugged into different upstream switches.
854 The following modes require the upstream switch to support 802.3ad with
855 successful LACP negotiation:
859 <dt><code>balance-tcp</code></dt>
861 Balances flows among slaves based on L2, L3, and L4 protocol
862 information such as destination MAC address, IP address, and TCP
867 <p>These columns apply only to bonded ports. Their values are
868 otherwise ignored.</p>
870 <column name="bond_mode">
871 <p>The type of bonding used for a bonded port. Defaults to
872 <code>active-backup</code> if unset.
876 <column name="other_config" key="bond-hash-basis"
877 type='{"type": "integer"}'>
878 An integer hashed along with flows when choosing output slaves in load
879 balanced bonds. When changed, all flows will be assigned different
880 hash values possibly causing slave selection decisions to change. Does
881 not affect bonding modes which do not employ load balancing such as
882 <code>active-backup</code>.
885 <group title="Link Failure Detection">
887 An important part of link bonding is detecting that links are down so
888 that they may be disabled. These settings determine how Open vSwitch
889 detects link failure.
892 <column name="other_config" key="bond-detect-mode"
893 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
894 The means used to detect link failures. Defaults to
895 <code>carrier</code> which uses each interface's carrier to detect
896 failures. When set to <code>miimon</code>, will check for failures
897 by polling each interface's MII.
900 <column name="other_config" key="bond-miimon-interval"
901 type='{"type": "integer"}'>
902 The interval, in milliseconds, between successive attempts to poll
903 each interface's MII. Relevant only when <ref column="other_config"
904 key="bond-detect-mode"/> is <code>miimon</code>.
907 <column name="bond_updelay">
909 The number of milliseconds for which the link must stay up on an
910 interface before the interface is considered to be up. Specify
911 <code>0</code> to enable the interface immediately.
915 This setting is honored only when at least one bonded interface is
916 already enabled. When no interfaces are enabled, then the first
917 bond interface to come up is enabled immediately.
921 <column name="bond_downdelay">
922 The number of milliseconds for which the link must stay down on an
923 interface before the interface is considered to be down. Specify
924 <code>0</code> to disable the interface immediately.
928 <group title="LACP Configuration">
930 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
931 allows switches to automatically detect that they are connected by
932 multiple links and aggregate across those links. These settings
933 control LACP behavior.
937 Configures LACP on this port. LACP allows directly connected
938 switches to negotiate which links may be bonded. LACP may be enabled
939 on non-bonded ports for the benefit of any switches they may be
940 connected to. <code>active</code> ports are allowed to initiate LACP
941 negotiations. <code>passive</code> ports are allowed to participate
942 in LACP negotiations initiated by a remote switch, but not allowed to
943 initiate such negotiations themselves. If LACP is enabled on a port
944 whose partner switch does not support LACP, the bond will be
945 disabled. Defaults to <code>off</code> if unset.
948 <column name="other_config" key="lacp-system-id">
949 The LACP system ID of this <ref table="Port"/>. The system ID of a
950 LACP bond is used to identify itself to its partners. Must be a
951 nonzero MAC address. Defaults to the bridge Ethernet address if
955 <column name="other_config" key="lacp-system-priority"
956 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
957 The LACP system priority of this <ref table="Port"/>. In LACP
958 negotiations, link status decisions are made by the system with the
959 numerically lower priority.
962 <column name="other_config" key="lacp-time"
963 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
965 The LACP timing which should be used on this <ref table="Port"/>.
966 By default <code>slow</code> is used. When configured to be
967 <code>fast</code> LACP heartbeats are requested at a rate of once
968 per second causing connectivity problems to be detected more
969 quickly. In <code>slow</code> mode, heartbeats are requested at a
970 rate of once every 30 seconds.
975 <group title="Rebalancing Configuration">
977 These settings control behavior when a bond is in
978 <code>balance-slb</code> or <code>balance-tcp</code> mode.
981 <column name="other_config" key="bond-rebalance-interval"
982 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
983 For a load balanced bonded port, the number of milliseconds between
984 successive attempts to rebalance the bond, that is, to move flows
985 from one interface on the bond to another in an attempt to keep usage
986 of each interface roughly equal. If zero, load balancing is disabled
987 on the bond (link failure still cause flows to move). If
988 less than 1000ms, the rebalance interval will be 1000ms.
992 <column name="bond_fake_iface">
993 For a bonded port, whether to create a fake internal interface with the
994 name of the port. Use only for compatibility with legacy software that
999 <group title="Spanning Tree Configuration">
1000 <column name="other_config" key="stp-enable"
1001 type='{"type": "boolean"}'>
1002 If spanning tree is enabled on the bridge, member ports are
1003 enabled by default (with the exception of bond, internal, and
1004 mirror ports which do not work with STP). If this column's
1005 value is <code>false</code> spanning tree is disabled on the
1009 <column name="other_config" key="stp-port-num"
1010 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1011 The port number used for the lower 8 bits of the port-id. By
1012 default, the numbers will be assigned automatically. If any
1013 port's number is manually configured on a bridge, then they
1017 <column name="other_config" key="stp-port-priority"
1018 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1019 The port's relative priority value for determining the root
1020 port (the upper 8 bits of the port-id). A port with a lower
1021 port-id will be chosen as the root port. By default, the
1025 <column name="other_config" key="stp-path-cost"
1026 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1027 Spanning tree path cost for the port. A lower number indicates
1028 a faster link. By default, the cost is based on the maximum
1033 <group title="Other Features">
1035 Quality of Service configuration for this port.
1039 The MAC address to use for this port for the purpose of choosing the
1040 bridge's MAC address. This column does not necessarily reflect the
1041 port's actual MAC address, nor will setting it change the port's actual
1045 <column name="fake_bridge">
1046 Does this port represent a sub-bridge for its tagged VLAN within the
1047 Bridge? See ovs-vsctl(8) for more information.
1050 <column name="external_ids" key="fake-bridge-id-*">
1051 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1052 column) are defined by prefixing a <ref table="Bridge"/> <ref
1053 table="Bridge" column="external_ids"/> key with
1054 <code>fake-bridge-</code>,
1055 e.g. <code>fake-bridge-xs-network-uuids</code>.
1059 <group title="Port Status">
1061 Status information about ports attached to bridges.
1063 <column name="status">
1064 Key-value pairs that report port status.
1066 <column name="status" key="stp_port_id">
1068 The port-id (in hex) used in spanning tree advertisements for
1069 this port. Configuring the port-id is described in the
1070 <code>stp-port-num</code> and <code>stp-port-priority</code>
1071 keys of the <code>other_config</code> section earlier.
1074 <column name="status" key="stp_state"
1075 type='{"type": "string", "enum": ["set",
1076 ["disabled", "listening", "learning",
1077 "forwarding", "blocking"]]}'>
1079 STP state of the port.
1082 <column name="status" key="stp_sec_in_state"
1083 type='{"type": "integer", "minInteger": 0}'>
1085 The amount of time (in seconds) port has been in the current
1089 <column name="status" key="stp_role"
1090 type='{"type": "string", "enum": ["set",
1091 ["root", "designated", "alternate"]]}'>
1093 STP role of the port.
1098 <group title="Port Statistics">
1100 Key-value pairs that report port statistics.
1102 <group title="Statistics: STP transmit and receive counters">
1103 <column name="statistics" key="stp_tx_count">
1104 Number of STP BPDUs sent on this port by the spanning
1107 <column name="statistics" key="stp_rx_count">
1108 Number of STP BPDUs received on this port and accepted by the
1109 spanning tree library.
1111 <column name="statistics" key="stp_error_count">
1112 Number of bad STP BPDUs received on this port. Bad BPDUs
1113 include runt packets and those with an unexpected protocol ID.
1118 <group title="Common Columns">
1119 The overall purpose of these columns is described under <code>Common
1120 Columns</code> at the beginning of this document.
1122 <column name="other_config"/>
1123 <column name="external_ids"/>
1127 <table name="Interface" title="One physical network device in a Port.">
1128 An interface within a <ref table="Port"/>.
1130 <group title="Core Features">
1131 <column name="name">
1132 Interface name. Should be alphanumeric and no more than about 8 bytes
1133 long. May be the same as the port name, for non-bonded ports. Must
1134 otherwise be unique among the names of ports, interfaces, and bridges
1138 <column name="mac_in_use">
1139 The MAC address in use by this interface.
1143 <p>Ethernet address to set for this interface. If unset then the
1144 default MAC address is used:</p>
1146 <li>For the local interface, the default is the lowest-numbered MAC
1147 address among the other bridge ports, either the value of the
1148 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1149 if set, or its actual MAC (for bonded ports, the MAC of its slave
1150 whose name is first in alphabetical order). Internal ports and
1151 bridge ports that are used as port mirroring destinations (see the
1152 <ref table="Mirror"/> table) are ignored.</li>
1153 <li>For other internal interfaces, the default MAC is randomly
1155 <li>External interfaces typically have a MAC address associated with
1156 their hardware.</li>
1158 <p>Some interfaces may not have a software-controllable MAC
1162 <column name="ofport">
1163 <p>OpenFlow port number for this interface. Unlike most columns, this
1164 column's value should be set only by Open vSwitch itself. Other
1165 clients should set this column to an empty set (the default) when
1166 creating an <ref table="Interface"/>.</p>
1167 <p>Open vSwitch populates this column when the port number becomes
1168 known. If the interface is successfully added,
1169 <ref column="ofport"/> will be set to a number between 1 and 65535
1170 (generally either in the range 1 to 65279, inclusive, or 65534, the
1171 port number for the OpenFlow ``local port''). If the interface
1172 cannot be added then Open vSwitch sets this column
1174 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1175 an appropriate value for this column and then tries to keep the value
1176 constant across restarts.</p>
1179 <column name="ofport_request">
1180 <p>Requested OpenFlow port number for this interface. The port
1181 number must be between 1 and 65279, inclusive. Some datapaths
1182 cannot satisfy all requests for particular port numbers. When
1183 this column is empty or the request cannot be fulfilled, the
1184 system will choose a free port. The <ref column="ofport"/>
1185 column reports the assigned OpenFlow port number.</p>
1186 <p>The port number must be requested in the same transaction
1187 that creates the port.</p>
1191 <group title="System-Specific Details">
1192 <column name="type">
1194 The interface type, one of:
1198 <dt><code>system</code></dt>
1199 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1200 Sometimes referred to as ``external interfaces'' since they are
1201 generally connected to hardware external to that on which the Open
1202 vSwitch is running. The empty string is a synonym for
1203 <code>system</code>.</dd>
1205 <dt><code>internal</code></dt>
1206 <dd>A simulated network device that sends and receives traffic. An
1207 internal interface whose <ref column="name"/> is the same as its
1208 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1209 ``local interface.'' It does not make sense to bond an internal
1210 interface, so the terms ``port'' and ``interface'' are often used
1211 imprecisely for internal interfaces.</dd>
1213 <dt><code>tap</code></dt>
1214 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1216 <dt><code>gre</code></dt>
1218 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1222 <dt><code>ipsec_gre</code></dt>
1224 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1228 <dt><code>gre64</code></dt>
1230 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1231 of key, it uses GRE protocol sequence number field. This is non
1232 standard use of GRE protocol since OVS does not increment
1233 sequence number for every packet at time of encap as expected by
1234 standard GRE implementation. See <ref group="Tunnel Options"/>
1235 for information on configuring GRE tunnels.
1238 <dt><code>ipsec_gre64</code></dt>
1240 Same as IPSEC_GRE except 64 bit key.
1243 <dt><code>vxlan</code></dt>
1246 An Ethernet tunnel over the experimental, UDP-based VXLAN
1247 protocol described at
1248 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1249 VXLAN is currently supported only with the Linux kernel datapath
1250 with kernel version 2.6.26 or later.
1253 Open vSwitch uses UDP destination port 4789. The source port used for
1254 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1259 <dt><code>lisp</code></dt>
1261 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1262 Separation Protocol (RFC 6830). LISP is currently supported only
1263 with the Linux kernel datapath with kernel version 2.6.26 or later.
1266 <dt><code>patch</code></dt>
1268 A pair of virtual devices that act as a patch cable.
1271 <dt><code>null</code></dt>
1272 <dd>An ignored interface. Deprecated and slated for removal in
1278 <group title="Tunnel Options">
1280 These options apply to interfaces with <ref column="type"/> of
1281 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1282 <code>ipsec_gre64</code>, <code>vxlan</code>, and <code>lisp</code>.
1286 Each tunnel must be uniquely identified by the combination of <ref
1287 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1288 column="options" key="local_ip"/>, and <ref column="options"
1289 key="in_key"/>. If two ports are defined that are the same except one
1290 has an optional identifier and the other does not, the more specific
1291 one is matched first. <ref column="options" key="in_key"/> is
1292 considered more specific than <ref column="options" key="local_ip"/> if
1293 a port defines one and another port defines the other.
1296 <column name="options" key="remote_ip">
1297 <p>Required. The remote tunnel endpoint, one of:</p>
1301 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1302 Only unicast endpoints are supported.
1305 The word <code>flow</code>. The tunnel accepts packets from any
1306 remote tunnel endpoint. To process only packets from a specific
1307 remote tunnel endpoint, the flow entries may match on the
1308 <code>tun_src</code> field. When sending packets to a
1309 <code>remote_ip=flow</code> tunnel, the flow actions must
1310 explicitly set the <code>tun_dst</code> field to the IP address of
1311 the desired remote tunnel endpoint, e.g. with a
1312 <code>set_field</code> action.
1317 The remote tunnel endpoint for any packet received from a tunnel
1318 is available in the <code>tun_src</code> field for matching in the
1323 <column name="options" key="local_ip">
1325 Optional. The tunnel destination IP that received packets must
1326 match. Default is to match all addresses. If specified, may be one
1332 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1335 The word <code>flow</code>. The tunnel accepts packets sent to any
1336 of the local IP addresses of the system running OVS. To process
1337 only packets sent to a specific IP address, the flow entries may
1338 match on the <code>tun_dst</code> field. When sending packets to a
1339 <code>local_ip=flow</code> tunnel, the flow actions may
1340 explicitly set the <code>tun_src</code> field to the desired IP
1341 address, e.g. with a <code>set_field</code> action. However, while
1342 routing the tunneled packet out, the local system may override the
1343 specified address with the local IP address configured for the
1344 outgoing system interface.
1347 This option is valid only for tunnels also configured with the
1348 <code>remote_ip=flow</code> option.
1354 The tunnel destination IP address for any packet received from a
1355 tunnel is available in the <code>tun_dst</code> field for matching in
1360 <column name="options" key="in_key">
1361 <p>Optional. The key that received packets must contain, one of:</p>
1365 <code>0</code>. The tunnel receives packets with no key or with a
1366 key of 0. This is equivalent to specifying no <ref column="options"
1367 key="in_key"/> at all.
1370 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1371 (for GRE64) number. The tunnel receives only packets with the
1375 The word <code>flow</code>. The tunnel accepts packets with any
1376 key. The key will be placed in the <code>tun_id</code> field for
1377 matching in the flow table. The <code>ovs-ofctl</code> manual page
1378 contains additional information about matching fields in OpenFlow
1387 <column name="options" key="out_key">
1388 <p>Optional. The key to be set on outgoing packets, one of:</p>
1392 <code>0</code>. Packets sent through the tunnel will have no key.
1393 This is equivalent to specifying no <ref column="options"
1394 key="out_key"/> at all.
1397 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1398 (for GRE64) number. Packets sent through the tunnel will have the
1402 The word <code>flow</code>. Packets sent through the tunnel will
1403 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1404 vendor extension (0 is used in the absence of an action). The
1405 <code>ovs-ofctl</code> manual page contains additional information
1406 about the Nicira OpenFlow vendor extensions.
1411 <column name="options" key="key">
1412 Optional. Shorthand to set <code>in_key</code> and
1413 <code>out_key</code> at the same time.
1416 <column name="options" key="tos">
1417 Optional. The value of the ToS bits to be set on the encapsulating
1418 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1419 zero. It may also be the word <code>inherit</code>, in which case
1420 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1421 (otherwise it will be 0). The ECN fields are always inherited.
1425 <column name="options" key="ttl">
1426 Optional. The TTL to be set on the encapsulating packet. It may also
1427 be the word <code>inherit</code>, in which case the TTL will be copied
1428 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1429 system default, typically 64). Default is the system default TTL.
1432 <column name="options" key="df_default"
1433 type='{"type": "boolean"}'>
1434 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1435 outer headers to allow path MTU discovery. Default is enabled; set
1436 to <code>false</code> to disable.
1439 <group title="Tunnel Options: gre and ipsec_gre only">
1441 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1445 <column name="options" key="csum" type='{"type": "boolean"}'>
1447 Optional. Compute GRE checksums on outgoing packets. Default is
1448 disabled, set to <code>true</code> to enable. Checksums present on
1449 incoming packets will be validated regardless of this setting.
1453 GRE checksums impose a significant performance penalty because they
1454 cover the entire packet. The encapsulated L3, L4, and L7 packet
1455 contents typically have their own checksums, so this additional
1456 checksum only adds value for the GRE and encapsulated L2 headers.
1460 This option is supported for <code>ipsec_gre</code>, but not useful
1461 because GRE checksums are weaker than, and redundant with, IPsec
1462 payload authentication.
1467 <group title="Tunnel Options: ipsec_gre only">
1469 Only <code>ipsec_gre</code> interfaces support these options.
1472 <column name="options" key="peer_cert">
1473 Required for certificate authentication. A string containing the
1474 peer's certificate in PEM format. Additionally the host's
1475 certificate must be specified with the <code>certificate</code>
1479 <column name="options" key="certificate">
1480 Required for certificate authentication. The name of a PEM file
1481 containing a certificate that will be presented to the peer during
1485 <column name="options" key="private_key">
1486 Optional for certificate authentication. The name of a PEM file
1487 containing the private key associated with <code>certificate</code>.
1488 If <code>certificate</code> contains the private key, this option may
1492 <column name="options" key="psk">
1493 Required for pre-shared key authentication. Specifies a pre-shared
1494 key for authentication that must be identical on both sides of the
1500 <group title="Patch Options">
1502 Only <code>patch</code> interfaces support these options.
1505 <column name="options" key="peer">
1506 The <ref column="name"/> of the <ref table="Interface"/> for the other
1507 side of the patch. The named <ref table="Interface"/>'s own
1508 <code>peer</code> option must specify this <ref table="Interface"/>'s
1509 name. That is, the two patch interfaces must have reversed <ref
1510 column="name"/> and <code>peer</code> values.
1514 <group title="Interface Status">
1516 Status information about interfaces attached to bridges, updated every
1517 5 seconds. Not all interfaces have all of these properties; virtual
1518 interfaces don't have a link speed, for example. Non-applicable
1519 columns will have empty values.
1521 <column name="admin_state">
1523 The administrative state of the physical network link.
1527 <column name="link_state">
1529 The observed state of the physical network link. This is ordinarily
1530 the link's carrier status. If the interface's <ref table="Port"/> is
1531 a bond configured for miimon monitoring, it is instead the network
1532 link's miimon status.
1536 <column name="link_resets">
1538 The number of times Open vSwitch has observed the
1539 <ref column="link_state"/> of this <ref table="Interface"/> change.
1543 <column name="link_speed">
1545 The negotiated speed of the physical network link.
1546 Valid values are positive integers greater than 0.
1550 <column name="duplex">
1552 The duplex mode of the physical network link.
1558 The MTU (maximum transmission unit); i.e. the largest
1559 amount of data that can fit into a single Ethernet frame.
1560 The standard Ethernet MTU is 1500 bytes. Some physical media
1561 and many kinds of virtual interfaces can be configured with
1565 This column will be empty for an interface that does not
1566 have an MTU as, for example, some kinds of tunnels do not.
1570 <column name="lacp_current">
1571 Boolean value indicating LACP status for this interface. If true, this
1572 interface has current LACP information about its LACP partner. This
1573 information may be used to monitor the health of interfaces in a LACP
1574 enabled port. This column will be empty if LACP is not enabled.
1577 <column name="status">
1578 Key-value pairs that report port status. Supported status values are
1579 <ref column="type"/>-dependent; some interfaces may not have a valid
1580 <ref column="status" key="driver_name"/>, for example.
1583 <column name="status" key="driver_name">
1584 The name of the device driver controlling the network adapter.
1587 <column name="status" key="driver_version">
1588 The version string of the device driver controlling the network
1592 <column name="status" key="firmware_version">
1593 The version string of the network adapter's firmware, if available.
1596 <column name="status" key="source_ip">
1597 The source IP address used for an IPv4 tunnel end-point, such as
1601 <column name="status" key="tunnel_egress_iface">
1602 Egress interface for tunnels. Currently only relevant for GRE tunnels
1603 On Linux systems, this column will show the name of the interface
1604 which is responsible for routing traffic destined for the configured
1605 <ref column="options" key="remote_ip"/>. This could be an internal
1606 interface such as a bridge port.
1609 <column name="status" key="tunnel_egress_iface_carrier"
1610 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1611 Whether carrier is detected on <ref column="status"
1612 key="tunnel_egress_iface"/>.
1616 <group title="Statistics">
1618 Key-value pairs that report interface statistics. The current
1619 implementation updates these counters periodically. Future
1620 implementations may update them when an interface is created, when they
1621 are queried (e.g. using an OVSDB <code>select</code> operation), and
1622 just before an interface is deleted due to virtual interface hot-unplug
1623 or VM shutdown, and perhaps at other times, but not on any regular
1627 These are the same statistics reported by OpenFlow in its <code>struct
1628 ofp_port_stats</code> structure. If an interface does not support a
1629 given statistic, then that pair is omitted.
1631 <group title="Statistics: Successful transmit and receive counters">
1632 <column name="statistics" key="rx_packets">
1633 Number of received packets.
1635 <column name="statistics" key="rx_bytes">
1636 Number of received bytes.
1638 <column name="statistics" key="tx_packets">
1639 Number of transmitted packets.
1641 <column name="statistics" key="tx_bytes">
1642 Number of transmitted bytes.
1645 <group title="Statistics: Receive errors">
1646 <column name="statistics" key="rx_dropped">
1647 Number of packets dropped by RX.
1649 <column name="statistics" key="rx_frame_err">
1650 Number of frame alignment errors.
1652 <column name="statistics" key="rx_over_err">
1653 Number of packets with RX overrun.
1655 <column name="statistics" key="rx_crc_err">
1656 Number of CRC errors.
1658 <column name="statistics" key="rx_errors">
1659 Total number of receive errors, greater than or equal to the sum of
1663 <group title="Statistics: Transmit errors">
1664 <column name="statistics" key="tx_dropped">
1665 Number of packets dropped by TX.
1667 <column name="statistics" key="collisions">
1668 Number of collisions.
1670 <column name="statistics" key="tx_errors">
1671 Total number of transmit errors, greater than or equal to the sum of
1677 <group title="Ingress Policing">
1679 These settings control ingress policing for packets received on this
1680 interface. On a physical interface, this limits the rate at which
1681 traffic is allowed into the system from the outside; on a virtual
1682 interface (one connected to a virtual machine), this limits the rate at
1683 which the VM is able to transmit.
1686 Policing is a simple form of quality-of-service that simply drops
1687 packets received in excess of the configured rate. Due to its
1688 simplicity, policing is usually less accurate and less effective than
1689 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1690 table="Queue"/> tables).
1693 Policing is currently implemented only on Linux. The Linux
1694 implementation uses a simple ``token bucket'' approach:
1698 The size of the bucket corresponds to <ref
1699 column="ingress_policing_burst"/>. Initially the bucket is full.
1702 Whenever a packet is received, its size (converted to tokens) is
1703 compared to the number of tokens currently in the bucket. If the
1704 required number of tokens are available, they are removed and the
1705 packet is forwarded. Otherwise, the packet is dropped.
1708 Whenever it is not full, the bucket is refilled with tokens at the
1709 rate specified by <ref column="ingress_policing_rate"/>.
1713 Policing interacts badly with some network protocols, and especially
1714 with fragmented IP packets. Suppose that there is enough network
1715 activity to keep the bucket nearly empty all the time. Then this token
1716 bucket algorithm will forward a single packet every so often, with the
1717 period depending on packet size and on the configured rate. All of the
1718 fragments of an IP packets are normally transmitted back-to-back, as a
1719 group. In such a situation, therefore, only one of these fragments
1720 will be forwarded and the rest will be dropped. IP does not provide
1721 any way for the intended recipient to ask for only the remaining
1722 fragments. In such a case there are two likely possibilities for what
1723 will happen next: either all of the fragments will eventually be
1724 retransmitted (as TCP will do), in which case the same problem will
1725 recur, or the sender will not realize that its packet has been dropped
1726 and data will simply be lost (as some UDP-based protocols will do).
1727 Either way, it is possible that no forward progress will ever occur.
1729 <column name="ingress_policing_rate">
1731 Maximum rate for data received on this interface, in kbps. Data
1732 received faster than this rate is dropped. Set to <code>0</code>
1733 (the default) to disable policing.
1737 <column name="ingress_policing_burst">
1738 <p>Maximum burst size for data received on this interface, in kb. The
1739 default burst size if set to <code>0</code> is 1000 kb. This value
1740 has no effect if <ref column="ingress_policing_rate"/>
1741 is <code>0</code>.</p>
1743 Specifying a larger burst size lets the algorithm be more forgiving,
1744 which is important for protocols like TCP that react severely to
1745 dropped packets. The burst size should be at least the size of the
1746 interface's MTU. Specifying a value that is numerically at least as
1747 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1748 closer to achieving the full rate.
1753 <group title="Bidirectional Forwarding Detection (BFD)">
1755 BFD, defined in RFC 5880 and RFC 5881, allows point to point
1756 detection of connectivity failures by occasional transmission of
1757 BFD control messages. It is implemented in Open vSwitch to serve
1758 as a more popular and standards compliant alternative to CFM.
1762 BFD operates by regularly transmitting BFD control messages at a
1763 rate negotiated independently in each direction. Each endpoint
1764 specifies the rate at which it expects to receive control messages,
1765 and the rate at which it's willing to transmit them. Open vSwitch
1766 uses a detection multiplier of three, meaning that an endpoint
1767 which fails to receive BFD control messages for a period of three
1768 times the expected reception rate, will signal a connectivity
1769 fault. In the case of a unidirectional connectivity issue, the
1770 system not receiving BFD control messages will signal the problem
1771 to its peer in the messages is transmists.
1775 The Open vSwitch implementation of BFD aims to comply faithfully
1776 with the requirements put forth in RFC 5880. Currently, the only
1777 known omission is ``Demand Mode'', which we hope to include in
1778 future. Open vSwitch does not implement the optional
1779 Authentication or ``Echo Mode'' features.
1782 <column name="bfd" key="enable">
1783 When <code>true</code> BFD is enabled on this
1784 <ref table="Interface"/>, otherwise it's disabled. Defaults to
1788 <column name="bfd" key="min_rx"
1789 type='{"type": "integer", "minInteger": 1}'>
1790 The fastest rate, in milliseconds, at which this BFD session is
1791 willing to receive BFD control messages. The actual rate may be
1792 slower if the remote endpoint isn't willing to transmit as quickly as
1793 specified. Defaults to <code>1000</code>.
1796 <column name="bfd" key="min_tx"
1797 type='{"type": "integer", "minInteger": 1}'>
1798 The fastest rate, in milliseconds, at which this BFD session is
1799 willing to transmit BFD control messages. The actual rate may be
1800 slower if the remote endpoint isn't willing to receive as quickly as
1801 specified. Defaults to <code>100</code>.
1804 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
1805 Concatenated path down may be used when the local system should not
1806 have traffic forwarded to it for some reason other than a connectivty
1807 failure on the interface being monitored. When a controller thinks
1808 this may be the case, it may set <code>cpath_down</code> to
1809 <code>true</code> which may cause the remote BFD session not to
1810 forward traffic to this <ref table="Interface"/>. Defaults to
1814 <column name="bfd_status" key="state"
1815 type='{"type": "string",
1816 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1817 State of the BFD session. The BFD session is fully healthy and
1818 negotiated if <code>UP</code>.
1821 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
1822 True if the BFD session believes this <ref table="Interface"/> may be
1823 used to forward traffic. Typically this means the local session is
1824 signaling <code>UP</code>, and the remote system isn't signaling a
1825 problem such as concatenated path down.
1828 <column name="bfd_status" key="diagnostic">
1829 A short message indicating what the BFD session thinks is wrong in
1833 <column name="bfd_status" key="remote_state"
1834 type='{"type": "string",
1835 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
1836 State of the remote endpoint's BFD session.
1839 <column name="bfd_status" key="remote_diagnostic">
1840 A short message indicating what the remote endpoint's BFD session
1841 thinks is wrong in case of a problem.
1845 <group title="Connectivity Fault Management">
1847 802.1ag Connectivity Fault Management (CFM) allows a group of
1848 Maintenance Points (MPs) called a Maintenance Association (MA) to
1849 detect connectivity problems with each other. MPs within a MA should
1850 have complete and exclusive interconnectivity. This is verified by
1851 occasionally broadcasting Continuity Check Messages (CCMs) at a
1852 configurable transmission interval.
1856 According to the 802.1ag specification, each Maintenance Point should
1857 be configured out-of-band with a list of Remote Maintenance Points it
1858 should have connectivity to. Open vSwitch differs from the
1859 specification in this area. It simply assumes the link is faulted if
1860 no Remote Maintenance Points are reachable, and considers it not
1865 When operating over tunnels which have no <code>in_key</code>, or an
1866 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1867 with a tunnel key of zero.
1870 <column name="cfm_mpid">
1871 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1872 a Maintenance Association. The MPID is used to identify this endpoint
1873 to other Maintenance Points in the MA. Each end of a link being
1874 monitored should have a different MPID. Must be configured to enable
1875 CFM on this <ref table="Interface"/>.
1878 <column name="cfm_fault">
1880 Indicates a connectivity fault triggered by an inability to receive
1881 heartbeats from any remote endpoint. When a fault is triggered on
1882 <ref table="Interface"/>s participating in bonds, they will be
1886 Faults can be triggered for several reasons. Most importantly they
1887 are triggered when no CCMs are received for a period of 3.5 times the
1888 transmission interval. Faults are also triggered when any CCMs
1889 indicate that a Remote Maintenance Point is not receiving CCMs but
1890 able to send them. Finally, a fault is triggered if a CCM is
1891 received which indicates unexpected configuration. Notably, this
1892 case arises when a CCM is received which advertises the local MPID.
1896 <column name="cfm_fault_status" key="recv">
1897 Indicates a CFM fault was triggered due to a lack of CCMs received on
1898 the <ref table="Interface"/>.
1901 <column name="cfm_fault_status" key="rdi">
1902 Indicates a CFM fault was triggered due to the reception of a CCM with
1903 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1904 are not receiving CCMs themselves. This typically indicates a
1905 unidirectional connectivity failure.
1908 <column name="cfm_fault_status" key="maid">
1909 Indicates a CFM fault was triggered due to the reception of a CCM with
1910 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1911 with an identification number in addition to the MPID called the MAID.
1912 Open vSwitch only supports receiving CCM broadcasts tagged with the
1913 MAID it uses internally.
1916 <column name="cfm_fault_status" key="loopback">
1917 Indicates a CFM fault was triggered due to the reception of a CCM
1918 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1919 column of this <ref table="Interface"/>. This may indicate a loop in
1923 <column name="cfm_fault_status" key="overflow">
1924 Indicates a CFM fault was triggered because the CFM module received
1925 CCMs from more remote endpoints than it can keep track of.
1928 <column name="cfm_fault_status" key="override">
1929 Indicates a CFM fault was manually triggered by an administrator using
1930 an <code>ovs-appctl</code> command.
1933 <column name="cfm_fault_status" key="interval">
1934 Indicates a CFM fault was triggered due to the reception of a CCM
1935 frame having an invalid interval.
1938 <column name="cfm_remote_opstate">
1939 <p>When in extended mode, indicates the operational state of the
1940 remote endpoint as either <code>up</code> or <code>down</code>. See
1941 <ref column="other_config" key="cfm_opstate"/>.
1945 <column name="cfm_health">
1947 Indicates the health of the interface as a percentage of CCM frames
1948 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1949 The health of an interface is undefined if it is communicating with
1950 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1951 healthy heartbeats are not received at the expected rate, and
1952 gradually improves as healthy heartbeats are received at the desired
1953 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1954 health of the interface is refreshed.
1957 As mentioned above, the faults can be triggered for several reasons.
1958 The link health will deteriorate even if heartbeats are received but
1959 they are reported to be unhealthy. An unhealthy heartbeat in this
1960 context is a heartbeat for which either some fault is set or is out
1961 of sequence. The interface health can be 100 only on receiving
1962 healthy heartbeats at the desired rate.
1966 <column name="cfm_remote_mpids">
1967 When CFM is properly configured, Open vSwitch will occasionally
1968 receive CCM broadcasts. These broadcasts contain the MPID of the
1969 sending Maintenance Point. The list of MPIDs from which this
1970 <ref table="Interface"/> is receiving broadcasts from is regularly
1971 collected and written to this column.
1974 <column name="other_config" key="cfm_interval"
1975 type='{"type": "integer"}'>
1977 The interval, in milliseconds, between transmissions of CFM
1978 heartbeats. Three missed heartbeat receptions indicate a
1983 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1984 60,000, or 600,000 ms are supported. Other values will be rounded
1985 down to the nearest value on the list. Extended mode (see <ref
1986 column="other_config" key="cfm_extended"/>) supports any interval up
1987 to 65,535 ms. In either mode, the default is 1000 ms.
1990 <p>We do not recommend using intervals less than 100 ms.</p>
1993 <column name="other_config" key="cfm_extended"
1994 type='{"type": "boolean"}'>
1995 When <code>true</code>, the CFM module operates in extended mode. This
1996 causes it to use a nonstandard destination address to avoid conflicting
1997 with compliant implementations which may be running concurrently on the
1998 network. Furthermore, extended mode increases the accuracy of the
1999 <code>cfm_interval</code> configuration parameter by breaking wire
2000 compatibility with 802.1ag compliant implementations. Defaults to
2004 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2006 When <code>true</code>, and
2007 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2008 module operates in demand mode. When in demand mode, traffic
2009 received on the <ref table="Interface"/> is used to indicate
2010 liveness. CCMs are still transmitted and received, but if the
2011 <ref table="Interface"/> is receiving traffic, their absence does not
2012 cause a connectivity fault.
2016 Demand mode has a couple of caveats:
2019 To ensure that ovs-vswitchd has enough time to pull statistics
2020 from the datapath, the minimum
2021 <ref column="other_config" key="cfm_interval"/> is 500ms.
2025 To avoid ambiguity, demand mode disables itself when there are
2026 multiple remote maintenance points.
2030 If the <ref table="Interface"/> is heavily congested, CCMs
2031 containing the <ref column="other_config" key="cfm_opstate"/>
2032 status may be dropped causing changes in the operational state to
2033 be delayed. Similarly, if CCMs containing the RDI bit are not
2034 received, unidirectional link failures may not be detected.
2040 <column name="other_config" key="cfm_opstate"
2041 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2042 When <code>down</code>, the CFM module marks all CCMs it generates as
2043 operationally down without triggering a fault. This allows remote
2044 maintenance points to choose not to forward traffic to the
2045 <ref table="Interface"/> on which this CFM module is running.
2046 Currently, in Open vSwitch, the opdown bit of CCMs affects
2047 <ref table="Interface"/>s participating in bonds, and the bundle
2048 OpenFlow action. This setting is ignored when CFM is not in extended
2049 mode. Defaults to <code>up</code>.
2052 <column name="other_config" key="cfm_ccm_vlan"
2053 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2054 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2055 with the given value. May be the string <code>random</code> in which
2056 case each CCM will be tagged with a different randomly generated VLAN.
2059 <column name="other_config" key="cfm_ccm_pcp"
2060 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2061 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2062 with the given PCP value, the VLAN ID of the tag is governed by the
2063 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2064 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2070 <group title="Bonding Configuration">
2071 <column name="other_config" key="lacp-port-id"
2072 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2073 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2074 used in LACP negotiations to identify individual ports
2075 participating in a bond.
2078 <column name="other_config" key="lacp-port-priority"
2079 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2080 The LACP port priority of this <ref table="Interface"/>. In LACP
2081 negotiations <ref table="Interface"/>s with numerically lower
2082 priorities are preferred for aggregation.
2085 <column name="other_config" key="lacp-aggregation-key"
2086 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2087 The LACP aggregation key of this <ref table="Interface"/>. <ref
2088 table="Interface"/>s with different aggregation keys may not be active
2089 within a given <ref table="Port"/> at the same time.
2093 <group title="Virtual Machine Identifiers">
2095 These key-value pairs specifically apply to an interface that
2096 represents a virtual Ethernet interface connected to a virtual
2097 machine. These key-value pairs should not be present for other types
2098 of interfaces. Keys whose names end in <code>-uuid</code> have
2099 values that uniquely identify the entity in question. For a Citrix
2100 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2101 Other hypervisors may use other formats.
2104 <column name="external_ids" key="attached-mac">
2105 The MAC address programmed into the ``virtual hardware'' for this
2106 interface, in the form
2107 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2108 For Citrix XenServer, this is the value of the <code>MAC</code> field
2109 in the VIF record for this interface.
2112 <column name="external_ids" key="iface-id">
2113 A system-unique identifier for the interface. On XenServer, this will
2114 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2117 <column name="external_ids" key="iface-status"
2118 type='{"type": "string",
2119 "enum": ["set", ["active", "inactive"]]}'>
2121 Hypervisors may sometimes have more than one interface associated
2122 with a given <ref column="external_ids" key="iface-id"/>, only one of
2123 which is actually in use at a given time. For example, in some
2124 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2125 for a single <ref column="external_ids" key="iface-id"/>, but only
2126 uses one of them at a time. A hypervisor that behaves this way must
2127 mark the currently in use interface <code>active</code> and the
2128 others <code>inactive</code>. A hypervisor that never has more than
2129 one interface for a given <ref column="external_ids" key="iface-id"/>
2130 may mark that interface <code>active</code> or omit <ref
2131 column="external_ids" key="iface-status"/> entirely.
2135 During VM migration, a given <ref column="external_ids"
2136 key="iface-id"/> might transiently be marked <code>active</code> on
2137 two different hypervisors. That is, <code>active</code> means that
2138 this <ref column="external_ids" key="iface-id"/> is the active
2139 instance within a single hypervisor, not in a broader scope.
2140 There is one exception: some hypervisors support ``migration'' from a
2141 given hypervisor to itself (most often for test purposes). During
2142 such a ``migration,'' two instances of a single <ref
2143 column="external_ids" key="iface-id"/> might both be briefly marked
2144 <code>active</code> on a single hypervisor.
2148 <column name="external_ids" key="xs-vif-uuid">
2149 The virtual interface associated with this interface.
2152 <column name="external_ids" key="xs-network-uuid">
2153 The virtual network to which this interface is attached.
2156 <column name="external_ids" key="vm-id">
2157 The VM to which this interface belongs. On XenServer, this will be the
2158 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2161 <column name="external_ids" key="xs-vm-uuid">
2162 The VM to which this interface belongs.
2166 <group title="VLAN Splinters">
2168 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2169 with buggy network drivers in old versions of Linux that do not
2170 properly support VLANs when VLAN devices are not used, at some cost
2171 in memory and performance.
2175 When VLAN splinters are enabled on a particular interface, Open vSwitch
2176 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2177 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2178 received on the VLAN device is treated as if it had been received on
2179 the interface on the particular VLAN.
2183 VLAN splinters consider a VLAN to be in use if:
2188 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2189 table="Port"/> record.
2193 The VLAN is listed within the <ref table="Port" column="trunks"/>
2194 column of the <ref table="Port"/> record of an interface on which
2195 VLAN splinters are enabled.
2197 An empty <ref table="Port" column="trunks"/> does not influence the
2198 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2199 will exceed the current 1,024 port per datapath limit.
2203 An OpenFlow flow within any bridge matches the VLAN.
2208 The same set of in-use VLANs applies to every interface on which VLAN
2209 splinters are enabled. That is, the set is not chosen separately for
2210 each interface but selected once as the union of all in-use VLANs based
2215 It does not make sense to enable VLAN splinters on an interface for an
2216 access port, or on an interface that is not a physical port.
2220 VLAN splinters are deprecated. When broken device drivers are no
2221 longer in widespread use, we will delete this feature.
2224 <column name="other_config" key="enable-vlan-splinters"
2225 type='{"type": "boolean"}'>
2227 Set to <code>true</code> to enable VLAN splinters on this interface.
2228 Defaults to <code>false</code>.
2232 VLAN splinters increase kernel and userspace memory overhead, so do
2233 not use them unless they are needed.
2237 VLAN splinters do not support 802.1p priority tags. Received
2238 priorities will appear to be 0, regardless of their actual values,
2239 and priorities on transmitted packets will also be cleared to 0.
2244 <group title="Common Columns">
2245 The overall purpose of these columns is described under <code>Common
2246 Columns</code> at the beginning of this document.
2248 <column name="other_config"/>
2249 <column name="external_ids"/>
2253 <table name="Flow_Table" title="OpenFlow table configuration">
2254 <p>Configuration for a particular OpenFlow table.</p>
2256 <column name="name">
2257 The table's name. Set this column to change the name that controllers
2258 will receive when they request table statistics, e.g. <code>ovs-ofctl
2259 dump-tables</code>. The name does not affect switch behavior.
2262 <column name="flow_limit">
2263 If set, limits the number of flows that may be added to the table. Open
2264 vSwitch may limit the number of flows in a table for other reasons,
2265 e.g. due to hardware limitations or for resource availability or
2266 performance reasons.
2269 <column name="overflow_policy">
2271 Controls the switch's behavior when an OpenFlow flow table modification
2272 request would add flows in excess of <ref column="flow_limit"/>. The
2273 supported values are:
2277 <dt><code>refuse</code></dt>
2279 Refuse to add the flow or flows. This is also the default policy
2280 when <ref column="overflow_policy"/> is unset.
2283 <dt><code>evict</code></dt>
2285 Delete the flow that will expire soonest. See <ref column="groups"/>
2291 <column name="groups">
2293 When <ref column="overflow_policy"/> is <code>evict</code>, this
2294 controls how flows are chosen for eviction when the flow table would
2295 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2296 of NXM fields or sub-fields, each of which takes one of the forms
2297 <code><var>field</var>[]</code> or
2298 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2299 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2300 <code>nicira-ext.h</code> for a complete list of NXM field names.
2304 When a flow must be evicted due to overflow, the flow to evict is
2305 chosen through an approximation of the following algorithm:
2310 Divide the flows in the table into groups based on the values of the
2311 specified fields or subfields, so that all of the flows in a given
2312 group have the same values for those fields. If a flow does not
2313 specify a given field, that field's value is treated as 0.
2317 Consider the flows in the largest group, that is, the group that
2318 contains the greatest number of flows. If two or more groups all
2319 have the same largest number of flows, consider the flows in all of
2324 Among the flows under consideration, choose the flow that expires
2325 soonest for eviction.
2330 The eviction process only considers flows that have an idle timeout or
2331 a hard timeout. That is, eviction never deletes permanent flows.
2332 (Permanent flows do count against <ref column="flow_limit"/>.)
2336 Open vSwitch ignores any invalid or unknown field specifications.
2340 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2341 column has no effect.
2346 <table name="QoS" title="Quality of Service configuration">
2347 <p>Quality of Service (QoS) configuration for each Port that
2350 <column name="type">
2351 <p>The type of QoS to implement. The currently defined types are
2354 <dt><code>linux-htb</code></dt>
2356 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2357 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2358 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2359 for information on how this classifier works and how to configure it.
2363 <dt><code>linux-hfsc</code></dt>
2365 Linux "Hierarchical Fair Service Curve" classifier.
2366 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2367 information on how this classifier works.
2372 <column name="queues">
2373 <p>A map from queue numbers to <ref table="Queue"/> records. The
2374 supported range of queue numbers depend on <ref column="type"/>. The
2375 queue numbers are the same as the <code>queue_id</code> used in
2376 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2380 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2381 actions when no specific queue has been set. When no configuration for
2382 queue 0 is present, it is automatically configured as if a <ref
2383 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2384 and <ref table="Queue" column="other_config"/> columns had been
2386 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2387 this case. With some queuing disciplines, this dropped all packets
2388 destined for the default queue.)
2392 <group title="Configuration for linux-htb and linux-hfsc">
2394 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2395 the following key-value pair:
2398 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2399 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2400 specified, for physical interfaces, the default is the link rate. For
2401 other interfaces or if the link rate cannot be determined, the default
2402 is currently 100 Mbps.
2406 <group title="Common Columns">
2407 The overall purpose of these columns is described under <code>Common
2408 Columns</code> at the beginning of this document.
2410 <column name="other_config"/>
2411 <column name="external_ids"/>
2415 <table name="Queue" title="QoS output queue.">
2416 <p>A configuration for a port output queue, used in configuring Quality of
2417 Service (QoS) features. May be referenced by <ref column="queues"
2418 table="QoS"/> column in <ref table="QoS"/> table.</p>
2420 <column name="dscp">
2421 If set, Open vSwitch will mark all traffic egressing this
2422 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2423 default <ref table="Queue"/> is only marked if it was explicitly selected
2424 as the <ref table="Queue"/> at the time the packet was output. If unset,
2425 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2429 <group title="Configuration for linux-htb QoS">
2431 <ref table="QoS"/> <ref table="QoS" column="type"/>
2432 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2433 It has the following key-value pairs defined.
2436 <column name="other_config" key="min-rate"
2437 type='{"type": "integer", "minInteger": 1}'>
2438 Minimum guaranteed bandwidth, in bit/s.
2441 <column name="other_config" key="max-rate"
2442 type='{"type": "integer", "minInteger": 1}'>
2443 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2444 queue's rate will not be allowed to exceed the specified value, even
2445 if excess bandwidth is available. If unspecified, defaults to no
2449 <column name="other_config" key="burst"
2450 type='{"type": "integer", "minInteger": 1}'>
2451 Burst size, in bits. This is the maximum amount of ``credits'' that a
2452 queue can accumulate while it is idle. Optional. Details of the
2453 <code>linux-htb</code> implementation require a minimum burst size, so
2454 a too-small <code>burst</code> will be silently ignored.
2457 <column name="other_config" key="priority"
2458 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2459 A queue with a smaller <code>priority</code> will receive all the
2460 excess bandwidth that it can use before a queue with a larger value
2461 receives any. Specific priority values are unimportant; only relative
2462 ordering matters. Defaults to 0 if unspecified.
2466 <group title="Configuration for linux-hfsc QoS">
2468 <ref table="QoS"/> <ref table="QoS" column="type"/>
2469 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2470 It has the following key-value pairs defined.
2473 <column name="other_config" key="min-rate"
2474 type='{"type": "integer", "minInteger": 1}'>
2475 Minimum guaranteed bandwidth, in bit/s.
2478 <column name="other_config" key="max-rate"
2479 type='{"type": "integer", "minInteger": 1}'>
2480 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2481 queue's rate will not be allowed to exceed the specified value, even if
2482 excess bandwidth is available. If unspecified, defaults to no
2487 <group title="Common Columns">
2488 The overall purpose of these columns is described under <code>Common
2489 Columns</code> at the beginning of this document.
2491 <column name="other_config"/>
2492 <column name="external_ids"/>
2496 <table name="Mirror" title="Port mirroring.">
2497 <p>A port mirror within a <ref table="Bridge"/>.</p>
2498 <p>A port mirror configures a bridge to send selected frames to special
2499 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2500 traffic may also be referred to as SPAN or RSPAN, depending on how
2501 the mirrored traffic is sent.</p>
2503 <column name="name">
2504 Arbitrary identifier for the <ref table="Mirror"/>.
2507 <group title="Selecting Packets for Mirroring">
2509 To be selected for mirroring, a given packet must enter or leave the
2510 bridge through a selected port and it must also be in one of the
2514 <column name="select_all">
2515 If true, every packet arriving or departing on any port is
2516 selected for mirroring.
2519 <column name="select_dst_port">
2520 Ports on which departing packets are selected for mirroring.
2523 <column name="select_src_port">
2524 Ports on which arriving packets are selected for mirroring.
2527 <column name="select_vlan">
2528 VLANs on which packets are selected for mirroring. An empty set
2529 selects packets on all VLANs.
2533 <group title="Mirroring Destination Configuration">
2535 These columns are mutually exclusive. Exactly one of them must be
2539 <column name="output_port">
2540 <p>Output port for selected packets, if nonempty.</p>
2541 <p>Specifying a port for mirror output reserves that port exclusively
2542 for mirroring. No frames other than those selected for mirroring
2544 will be forwarded to the port, and any frames received on the port
2545 will be discarded.</p>
2547 The output port may be any kind of port supported by Open vSwitch.
2548 It may be, for example, a physical port (sometimes called SPAN) or a
2553 <column name="output_vlan">
2554 <p>Output VLAN for selected packets, if nonempty.</p>
2555 <p>The frames will be sent out all ports that trunk
2556 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2557 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2558 trunk port, the frame's VLAN tag will be set to
2559 <ref column="output_vlan"/>, replacing any existing tag; when it is
2560 sent out an implicit VLAN port, the frame will not be tagged. This
2561 type of mirroring is sometimes called RSPAN.</p>
2563 See the documentation for
2564 <ref column="other_config" key="forward-bpdu"/> in the
2565 <ref table="Interface"/> table for a list of destination MAC
2566 addresses which will not be mirrored to a VLAN to avoid confusing
2567 switches that interpret the protocols that they represent.
2569 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2570 contains unmanaged switches. Consider an unmanaged physical switch
2571 with two ports: port 1, connected to an end host, and port 2,
2572 connected to an Open vSwitch configured to mirror received packets
2573 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2574 port 1 that the physical switch forwards to port 2. The Open vSwitch
2575 forwards this packet to its destination and then reflects it back on
2576 port 2 in VLAN 123. This reflected packet causes the unmanaged
2577 physical switch to replace the MAC learning table entry, which
2578 correctly pointed to port 1, with one that incorrectly points to port
2579 2. Afterward, the physical switch will direct packets destined for
2580 the end host to the Open vSwitch on port 2, instead of to the end
2581 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2582 desired in this scenario, then the physical switch must be replaced
2583 by one that learns Ethernet addresses on a per-VLAN basis. In
2584 addition, learning should be disabled on the VLAN containing mirrored
2585 traffic. If this is not done then intermediate switches will learn
2586 the MAC address of each end host from the mirrored traffic. If
2587 packets being sent to that end host are also mirrored, then they will
2588 be dropped since the switch will attempt to send them out the input
2589 port. Disabling learning for the VLAN will cause the switch to
2590 correctly send the packet out all ports configured for that VLAN. If
2591 Open vSwitch is being used as an intermediate switch, learning can be
2592 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2593 in the appropriate <ref table="Bridge"/> table or tables.</p>
2595 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2596 VLAN and should generally be preferred.
2601 <group title="Statistics: Mirror counters">
2603 Key-value pairs that report mirror statistics.
2605 <column name="statistics" key="tx_packets">
2606 Number of packets transmitted through this mirror.
2608 <column name="statistics" key="tx_bytes">
2609 Number of bytes transmitted through this mirror.
2613 <group title="Common Columns">
2614 The overall purpose of these columns is described under <code>Common
2615 Columns</code> at the beginning of this document.
2617 <column name="external_ids"/>
2621 <table name="Controller" title="OpenFlow controller configuration.">
2622 <p>An OpenFlow controller.</p>
2625 Open vSwitch supports two kinds of OpenFlow controllers:
2629 <dt>Primary controllers</dt>
2632 This is the kind of controller envisioned by the OpenFlow 1.0
2633 specification. Usually, a primary controller implements a network
2634 policy by taking charge of the switch's flow table.
2638 Open vSwitch initiates and maintains persistent connections to
2639 primary controllers, retrying the connection each time it fails or
2640 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2641 <ref table="Bridge"/> table applies to primary controllers.
2645 Open vSwitch permits a bridge to have any number of primary
2646 controllers. When multiple controllers are configured, Open
2647 vSwitch connects to all of them simultaneously. Because
2648 OpenFlow 1.0 does not specify how multiple controllers
2649 coordinate in interacting with a single switch, more than
2650 one primary controller should be specified only if the
2651 controllers are themselves designed to coordinate with each
2652 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2653 vendor extension may be useful for this.)
2656 <dt>Service controllers</dt>
2659 These kinds of OpenFlow controller connections are intended for
2660 occasional support and maintenance use, e.g. with
2661 <code>ovs-ofctl</code>. Usually a service controller connects only
2662 briefly to inspect or modify some of a switch's state.
2666 Open vSwitch listens for incoming connections from service
2667 controllers. The service controllers initiate and, if necessary,
2668 maintain the connections from their end. The <ref table="Bridge"
2669 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2670 not apply to service controllers.
2674 Open vSwitch supports configuring any number of service controllers.
2680 The <ref column="target"/> determines the type of controller.
2683 <group title="Core Features">
2684 <column name="target">
2685 <p>Connection method for controller.</p>
2687 The following connection methods are currently supported for primary
2691 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2693 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2694 the given <var>ip</var>, which must be expressed as an IP address
2695 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2696 column in the <ref table="Open_vSwitch"/> table must point to a
2697 valid SSL configuration when this form is used.</p>
2698 <p>SSL support is an optional feature that is not always built as
2699 part of Open vSwitch.</p>
2701 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2702 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2703 the given <var>ip</var>, which must be expressed as an IP address
2704 (not a DNS name).</dd>
2707 The following connection methods are currently supported for service
2711 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2714 Listens for SSL connections on the specified TCP <var>port</var>
2715 (default: 6633). If <var>ip</var>, which must be expressed as an
2716 IP address (not a DNS name), is specified, then connections are
2717 restricted to the specified local IP address.
2720 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2721 table="Open_vSwitch"/> table must point to a valid SSL
2722 configuration when this form is used.
2724 <p>SSL support is an optional feature that is not always built as
2725 part of Open vSwitch.</p>
2727 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2729 Listens for connections on the specified TCP <var>port</var>
2730 (default: 6633). If <var>ip</var>, which must be expressed as an
2731 IP address (not a DNS name), is specified, then connections are
2732 restricted to the specified local IP address.
2735 <p>When multiple controllers are configured for a single bridge, the
2736 <ref column="target"/> values must be unique. Duplicate
2737 <ref column="target"/> values yield unspecified results.</p>
2740 <column name="connection_mode">
2741 <p>If it is specified, this setting must be one of the following
2742 strings that describes how Open vSwitch contacts this OpenFlow
2743 controller over the network:</p>
2746 <dt><code>in-band</code></dt>
2747 <dd>In this mode, this controller's OpenFlow traffic travels over the
2748 bridge associated with the controller. With this setting, Open
2749 vSwitch allows traffic to and from the controller regardless of the
2750 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2751 would never be able to connect to the controller, because it did
2752 not have a flow to enable it.) This is the most common connection
2753 mode because it is not necessary to maintain two independent
2755 <dt><code>out-of-band</code></dt>
2756 <dd>In this mode, OpenFlow traffic uses a control network separate
2757 from the bridge associated with this controller, that is, the
2758 bridge does not use any of its own network devices to communicate
2759 with the controller. The control network must be configured
2760 separately, before or after <code>ovs-vswitchd</code> is started.
2764 <p>If not specified, the default is implementation-specific.</p>
2768 <group title="Controller Failure Detection and Handling">
2769 <column name="max_backoff">
2770 Maximum number of milliseconds to wait between connection attempts.
2771 Default is implementation-specific.
2774 <column name="inactivity_probe">
2775 Maximum number of milliseconds of idle time on connection to
2776 controller before sending an inactivity probe message. If Open
2777 vSwitch does not communicate with the controller for the specified
2778 number of seconds, it will send a probe. If a response is not
2779 received for the same additional amount of time, Open vSwitch
2780 assumes the connection has been broken and attempts to reconnect.
2781 Default is implementation-specific. A value of 0 disables
2786 <group title="Asynchronous Message Configuration">
2788 OpenFlow switches send certain messages to controllers spontanenously,
2789 that is, not in response to any request from the controller. These
2790 messages are called ``asynchronous messages.'' These columns allow
2791 asynchronous messages to be limited or disabled to ensure the best use
2792 of network resources.
2795 <column name="enable_async_messages">
2796 The OpenFlow protocol enables asynchronous messages at time of
2797 connection establishment, which means that a controller can receive
2798 asynchronous messages, potentially many of them, even if it turns them
2799 off immediately after connecting. Set this column to
2800 <code>false</code> to change Open vSwitch behavior to disable, by
2801 default, all asynchronous messages. The controller can use the
2802 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2803 on any messages that it does want to receive, if any.
2806 <column name="controller_rate_limit">
2808 The maximum rate at which the switch will forward packets to the
2809 OpenFlow controller, in packets per second. This feature prevents a
2810 single bridge from overwhelming the controller. If not specified,
2811 the default is implementation-specific.
2815 In addition, when a high rate triggers rate-limiting, Open vSwitch
2816 queues controller packets for each port and transmits them to the
2817 controller at the configured rate. The <ref
2818 column="controller_burst_limit"/> value limits the number of queued
2819 packets. Ports on a bridge share the packet queue fairly.
2823 Open vSwitch maintains two such packet rate-limiters per bridge: one
2824 for packets sent up to the controller because they do not correspond
2825 to any flow, and the other for packets sent up to the controller by
2826 request through flow actions. When both rate-limiters are filled with
2827 packets, the actual rate that packets are sent to the controller is
2828 up to twice the specified rate.
2832 <column name="controller_burst_limit">
2833 In conjunction with <ref column="controller_rate_limit"/>,
2834 the maximum number of unused packet credits that the bridge will
2835 allow to accumulate, in packets. If not specified, the default
2836 is implementation-specific.
2840 <group title="Additional In-Band Configuration">
2841 <p>These values are considered only in in-band control mode (see
2842 <ref column="connection_mode"/>).</p>
2844 <p>When multiple controllers are configured on a single bridge, there
2845 should be only one set of unique values in these columns. If different
2846 values are set for these columns in different controllers, the effect
2849 <column name="local_ip">
2850 The IP address to configure on the local port,
2851 e.g. <code>192.168.0.123</code>. If this value is unset, then
2852 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2856 <column name="local_netmask">
2857 The IP netmask to configure on the local port,
2858 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2859 but this value is unset, then the default is chosen based on whether
2860 the IP address is class A, B, or C.
2863 <column name="local_gateway">
2864 The IP address of the gateway to configure on the local port, as a
2865 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2866 this network has no gateway.
2870 <group title="Controller Status">
2871 <column name="is_connected">
2872 <code>true</code> if currently connected to this controller,
2873 <code>false</code> otherwise.
2877 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2878 <p>The level of authority this controller has on the associated
2879 bridge. Possible values are:</p>
2881 <dt><code>other</code></dt>
2882 <dd>Allows the controller access to all OpenFlow features.</dd>
2883 <dt><code>master</code></dt>
2884 <dd>Equivalent to <code>other</code>, except that there may be at
2885 most one master controller at a time. When a controller configures
2886 itself as <code>master</code>, any existing master is demoted to
2887 the <code>slave</code>role.</dd>
2888 <dt><code>slave</code></dt>
2889 <dd>Allows the controller read-only access to OpenFlow features.
2890 Attempts to modify the flow table will be rejected with an
2891 error. Slave controllers do not receive OFPT_PACKET_IN or
2892 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2897 <column name="status" key="last_error">
2898 A human-readable description of the last error on the connection
2899 to the controller; i.e. <code>strerror(errno)</code>. This key
2900 will exist only if an error has occurred.
2903 <column name="status" key="state"
2904 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2906 The state of the connection to the controller:
2909 <dt><code>VOID</code></dt>
2910 <dd>Connection is disabled.</dd>
2912 <dt><code>BACKOFF</code></dt>
2913 <dd>Attempting to reconnect at an increasing period.</dd>
2915 <dt><code>CONNECTING</code></dt>
2916 <dd>Attempting to connect.</dd>
2918 <dt><code>ACTIVE</code></dt>
2919 <dd>Connected, remote host responsive.</dd>
2921 <dt><code>IDLE</code></dt>
2922 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2925 These values may change in the future. They are provided only for
2930 <column name="status" key="sec_since_connect"
2931 type='{"type": "integer", "minInteger": 0}'>
2932 The amount of time since this controller last successfully connected to
2933 the switch (in seconds). Value is empty if controller has never
2934 successfully connected.
2937 <column name="status" key="sec_since_disconnect"
2938 type='{"type": "integer", "minInteger": 1}'>
2939 The amount of time since this controller last disconnected from
2940 the switch (in seconds). Value is empty if controller has never
2945 <group title="Connection Parameters">
2947 Additional configuration for a connection between the controller
2948 and the Open vSwitch.
2951 <column name="other_config" key="dscp"
2952 type='{"type": "integer"}'>
2953 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2954 in the Type of Service (TOS) field in the IP header. DSCP provides a
2955 mechanism to classify the network traffic and provide Quality of
2956 Service (QoS) on IP networks.
2958 The DSCP value specified here is used when establishing the connection
2959 between the controller and the Open vSwitch. If no value is specified,
2960 a default value of 48 is chosen. Valid DSCP values must be in the
2966 <group title="Common Columns">
2967 The overall purpose of these columns is described under <code>Common
2968 Columns</code> at the beginning of this document.
2970 <column name="external_ids"/>
2971 <column name="other_config"/>
2975 <table name="Manager" title="OVSDB management connection.">
2977 Configuration for a database connection to an Open vSwitch database
2982 This table primarily configures the Open vSwitch database
2983 (<code>ovsdb-server</code>), not the Open vSwitch switch
2984 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2985 what connections should be treated as in-band.
2989 The Open vSwitch database server can initiate and maintain active
2990 connections to remote clients. It can also listen for database
2994 <group title="Core Features">
2995 <column name="target">
2996 <p>Connection method for managers.</p>
2998 The following connection methods are currently supported:
3001 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3004 The specified SSL <var>port</var> (default: 6632) on the host at
3005 the given <var>ip</var>, which must be expressed as an IP address
3006 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
3007 column in the <ref table="Open_vSwitch"/> table must point to a
3008 valid SSL configuration when this form is used.
3011 SSL support is an optional feature that is not always built as
3012 part of Open vSwitch.
3016 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3018 The specified TCP <var>port</var> (default: 6632) on the host at
3019 the given <var>ip</var>, which must be expressed as an IP address
3022 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3025 Listens for SSL connections on the specified TCP <var>port</var>
3026 (default: 6632). Specify 0 for <var>port</var> to have the
3027 kernel automatically choose an available port. If <var>ip</var>,
3028 which must be expressed as an IP address (not a DNS name), is
3029 specified, then connections are restricted to the specified local
3033 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3034 table="Open_vSwitch"/> table must point to a valid SSL
3035 configuration when this form is used.
3038 SSL support is an optional feature that is not always built as
3039 part of Open vSwitch.
3042 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3044 Listens for connections on the specified TCP <var>port</var>
3045 (default: 6632). Specify 0 for <var>port</var> to have the kernel
3046 automatically choose an available port. If <var>ip</var>, which
3047 must be expressed as an IP address (not a DNS name), is specified,
3048 then connections are restricted to the specified local IP address.
3051 <p>When multiple managers are configured, the <ref column="target"/>
3052 values must be unique. Duplicate <ref column="target"/> values yield
3053 unspecified results.</p>
3056 <column name="connection_mode">
3058 If it is specified, this setting must be one of the following strings
3059 that describes how Open vSwitch contacts this OVSDB client over the
3064 <dt><code>in-band</code></dt>
3066 In this mode, this connection's traffic travels over a bridge
3067 managed by Open vSwitch. With this setting, Open vSwitch allows
3068 traffic to and from the client regardless of the contents of the
3069 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3070 to connect to the client, because it did not have a flow to enable
3071 it.) This is the most common connection mode because it is not
3072 necessary to maintain two independent networks.
3074 <dt><code>out-of-band</code></dt>
3076 In this mode, the client's traffic uses a control network separate
3077 from that managed by Open vSwitch, that is, Open vSwitch does not
3078 use any of its own network devices to communicate with the client.
3079 The control network must be configured separately, before or after
3080 <code>ovs-vswitchd</code> is started.
3085 If not specified, the default is implementation-specific.
3090 <group title="Client Failure Detection and Handling">
3091 <column name="max_backoff">
3092 Maximum number of milliseconds to wait between connection attempts.
3093 Default is implementation-specific.
3096 <column name="inactivity_probe">
3097 Maximum number of milliseconds of idle time on connection to the client
3098 before sending an inactivity probe message. If Open vSwitch does not
3099 communicate with the client for the specified number of seconds, it
3100 will send a probe. If a response is not received for the same
3101 additional amount of time, Open vSwitch assumes the connection has been
3102 broken and attempts to reconnect. Default is implementation-specific.
3103 A value of 0 disables inactivity probes.
3107 <group title="Status">
3108 <column name="is_connected">
3109 <code>true</code> if currently connected to this manager,
3110 <code>false</code> otherwise.
3113 <column name="status" key="last_error">
3114 A human-readable description of the last error on the connection
3115 to the manager; i.e. <code>strerror(errno)</code>. This key
3116 will exist only if an error has occurred.
3119 <column name="status" key="state"
3120 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3122 The state of the connection to the manager:
3125 <dt><code>VOID</code></dt>
3126 <dd>Connection is disabled.</dd>
3128 <dt><code>BACKOFF</code></dt>
3129 <dd>Attempting to reconnect at an increasing period.</dd>
3131 <dt><code>CONNECTING</code></dt>
3132 <dd>Attempting to connect.</dd>
3134 <dt><code>ACTIVE</code></dt>
3135 <dd>Connected, remote host responsive.</dd>
3137 <dt><code>IDLE</code></dt>
3138 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3141 These values may change in the future. They are provided only for
3146 <column name="status" key="sec_since_connect"
3147 type='{"type": "integer", "minInteger": 0}'>
3148 The amount of time since this manager last successfully connected
3149 to the database (in seconds). Value is empty if manager has never
3150 successfully connected.
3153 <column name="status" key="sec_since_disconnect"
3154 type='{"type": "integer", "minInteger": 0}'>
3155 The amount of time since this manager last disconnected from the
3156 database (in seconds). Value is empty if manager has never
3160 <column name="status" key="locks_held">
3161 Space-separated list of the names of OVSDB locks that the connection
3162 holds. Omitted if the connection does not hold any locks.
3165 <column name="status" key="locks_waiting">
3166 Space-separated list of the names of OVSDB locks that the connection is
3167 currently waiting to acquire. Omitted if the connection is not waiting
3171 <column name="status" key="locks_lost">
3172 Space-separated list of the names of OVSDB locks that the connection
3173 has had stolen by another OVSDB client. Omitted if no locks have been
3174 stolen from this connection.
3177 <column name="status" key="n_connections"
3178 type='{"type": "integer", "minInteger": 2}'>
3180 When <ref column="target"/> specifies a connection method that
3181 listens for inbound connections (e.g. <code>ptcp:</code> or
3182 <code>pssl:</code>) and more than one connection is actually active,
3183 the value is the number of active connections. Otherwise, this
3184 key-value pair is omitted.
3187 When multiple connections are active, status columns and key-value
3188 pairs (other than this one) report the status of one arbitrarily
3193 <column name="status" key="bound_port" type='{"type": "integer"}'>
3194 When <ref column="target"/> is <code>ptcp:</code> or
3195 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3196 listening. (This is is particularly useful when <ref
3197 column="target"/> specifies a port of 0, allowing the kernel to
3198 choose any available port.)
3202 <group title="Connection Parameters">
3204 Additional configuration for a connection between the manager
3205 and the Open vSwitch Database.
3208 <column name="other_config" key="dscp"
3209 type='{"type": "integer"}'>
3210 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3211 in the Type of Service (TOS) field in the IP header. DSCP provides a
3212 mechanism to classify the network traffic and provide Quality of
3213 Service (QoS) on IP networks.
3215 The DSCP value specified here is used when establishing the connection
3216 between the manager and the Open vSwitch. If no value is specified, a
3217 default value of 48 is chosen. Valid DSCP values must be in the range
3222 <group title="Common Columns">
3223 The overall purpose of these columns is described under <code>Common
3224 Columns</code> at the beginning of this document.
3226 <column name="external_ids"/>
3227 <column name="other_config"/>
3231 <table name="NetFlow">
3232 A NetFlow target. NetFlow is a protocol that exports a number of
3233 details about terminating IP flows, such as the principals involved
3236 <column name="targets">
3237 NetFlow targets in the form
3238 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3239 must be specified numerically, not as a DNS name.
3242 <column name="engine_id">
3243 Engine ID to use in NetFlow messages. Defaults to datapath index
3247 <column name="engine_type">
3248 Engine type to use in NetFlow messages. Defaults to datapath
3249 index if not specified.
3252 <column name="active_timeout">
3253 The interval at which NetFlow records are sent for flows that are
3254 still active, in seconds. A value of <code>0</code> requests the
3255 default timeout (currently 600 seconds); a value of <code>-1</code>
3256 disables active timeouts.
3259 <column name="add_id_to_interface">
3260 <p>If this column's value is <code>false</code>, the ingress and egress
3261 interface fields of NetFlow flow records are derived from OpenFlow port
3262 numbers. When it is <code>true</code>, the 7 most significant bits of
3263 these fields will be replaced by the least significant 7 bits of the
3264 engine id. This is useful because many NetFlow collectors do not
3265 expect multiple switches to be sending messages from the same host, so
3266 they do not store the engine information which could be used to
3267 disambiguate the traffic.</p>
3268 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3271 <group title="Common Columns">
3272 The overall purpose of these columns is described under <code>Common
3273 Columns</code> at the beginning of this document.
3275 <column name="external_ids"/>
3280 SSL configuration for an Open_vSwitch.
3282 <column name="private_key">
3283 Name of a PEM file containing the private key used as the switch's
3284 identity for SSL connections to the controller.
3287 <column name="certificate">
3288 Name of a PEM file containing a certificate, signed by the
3289 certificate authority (CA) used by the controller and manager,
3290 that certifies the switch's private key, identifying a trustworthy
3294 <column name="ca_cert">
3295 Name of a PEM file containing the CA certificate used to verify
3296 that the switch is connected to a trustworthy controller.
3299 <column name="bootstrap_ca_cert">
3300 If set to <code>true</code>, then Open vSwitch will attempt to
3301 obtain the CA certificate from the controller on its first SSL
3302 connection and save it to the named PEM file. If it is successful,
3303 it will immediately drop the connection and reconnect, and from then
3304 on all SSL connections must be authenticated by a certificate signed
3305 by the CA certificate thus obtained. <em>This option exposes the
3306 SSL connection to a man-in-the-middle attack obtaining the initial
3307 CA certificate.</em> It may still be useful for bootstrapping.
3310 <group title="Common Columns">
3311 The overall purpose of these columns is described under <code>Common
3312 Columns</code> at the beginning of this document.
3314 <column name="external_ids"/>
3318 <table name="sFlow">
3319 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
3320 monitoring of switches.</p>
3322 <column name="agent">
3323 Name of the network device whose IP address should be reported as the
3324 ``agent address'' to collectors. If not specified, the agent device is
3325 figured from the first target address and the routing table. If the
3326 routing table does not contain a route to the target, the IP address
3327 defaults to the <ref table="Controller" column="local_ip"/> in the
3328 collector's <ref table="Controller"/>. If an agent IP address cannot be
3329 determined any of these ways, sFlow is disabled.
3332 <column name="header">
3333 Number of bytes of a sampled packet to send to the collector.
3334 If not specified, the default is 128 bytes.
3337 <column name="polling">
3338 Polling rate in seconds to send port statistics to the collector.
3339 If not specified, defaults to 30 seconds.
3342 <column name="sampling">
3343 Rate at which packets should be sampled and sent to the collector.
3344 If not specified, defaults to 400, which means one out of 400
3345 packets, on average, will be sent to the collector.
3348 <column name="targets">
3349 sFlow targets in the form
3350 <code><var>ip</var>:<var>port</var></code>.
3353 <group title="Common Columns">
3354 The overall purpose of these columns is described under <code>Common
3355 Columns</code> at the beginning of this document.
3357 <column name="external_ids"/>
3361 <table name="IPFIX">
3362 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
3363 number of details about flows.</p>
3365 <column name="targets">
3366 IPFIX target collectors in the form
3367 <code><var>ip</var>:<var>port</var></code>.
3370 <column name="sampling">
3371 For per-bridge packet sampling, i.e. when this row is referenced
3372 from a <ref table="Bridge"/>, the rate at which packets should
3373 be sampled and sent to each target collector. If not specified,
3374 defaults to 400, which means one out of 400 packets, on average,
3375 will be sent to each target collector. Ignored for per-flow
3376 sampling, i.e. when this row is referenced from a <ref
3377 table="Flow_Sample_Collector_Set"/>.
3380 <column name="obs_domain_id">
3381 For per-bridge packet sampling, i.e. when this row is referenced
3382 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
3383 sent in each IPFIX packet. If not specified, defaults to 0.
3384 Ignored for per-flow sampling, i.e. when this row is referenced
3385 from a <ref table="Flow_Sample_Collector_Set"/>.
3388 <column name="obs_point_id">
3389 For per-bridge packet sampling, i.e. when this row is referenced
3390 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
3391 sent in each IPFIX flow record. If not specified, defaults to
3392 0. Ignored for per-flow sampling, i.e. when this row is
3393 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
3396 <group title="Common Columns">
3397 The overall purpose of these columns is described under <code>Common
3398 Columns</code> at the beginning of this document.
3400 <column name="external_ids"/>
3404 <table name="Flow_Sample_Collector_Set">
3405 <p>A set of IPFIX collectors of packet samples generated by
3406 OpenFlow <code>sample</code> actions.</p>
3409 The ID of this collector set, unique among the bridge's
3410 collector sets, to be used as the <code>collector_set_id</code>
3411 in OpenFlow <code>sample</code> actions.
3414 <column name="bridge">
3415 The bridge into which OpenFlow <code>sample</code> actions can
3416 be added to send packet samples to this set of IPFIX collectors.
3419 <column name="ipfix">
3420 Configuration of the set of IPFIX collectors to send one flow
3421 record per sampled packet to.
3424 <group title="Common Columns">
3425 The overall purpose of these columns is described under <code>Common
3426 Columns</code> at the beginning of this document.
3428 <column name="external_ids"/>