1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="disable-in-band"
443 type='{"type": "boolean"}'>
444 If set to <code>true</code>, disable in-band control on the bridge
445 regardless of controller and manager settings.
448 <column name="other_config" key="in-band-queue"
449 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
450 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
451 that will be used by flows set up by in-band control on this bridge.
452 If unset, or if the port used by an in-band control flow does not have
453 QoS configured, or if the port does not have a queue with the specified
454 ID, the default queue is used instead.
458 <group title="Spanning Tree Configuration">
459 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
460 that ensures loop-free topologies. It allows redundant links to
461 be included in the network to provide automatic backup paths if
462 the active links fails.
464 <column name="stp_enable">
465 Enable spanning tree on the bridge. By default, STP is disabled
466 on bridges. Bond, internal, and mirror ports are not supported
467 and will not participate in the spanning tree.
470 <column name="other_config" key="stp-system-id">
471 The bridge's STP identifier (the lower 48 bits of the bridge-id)
473 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
474 By default, the identifier is the MAC address of the bridge.
477 <column name="other_config" key="stp-priority"
478 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
479 The bridge's relative priority value for determining the root
480 bridge (the upper 16 bits of the bridge-id). A bridge with the
481 lowest bridge-id is elected the root. By default, the priority
485 <column name="other_config" key="stp-hello-time"
486 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
487 The interval between transmissions of hello messages by
488 designated ports, in seconds. By default the hello interval is
492 <column name="other_config" key="stp-max-age"
493 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
494 The maximum age of the information transmitted by the bridge
495 when it is the root bridge, in seconds. By default, the maximum
499 <column name="other_config" key="stp-forward-delay"
500 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
501 The delay to wait between transitioning root and designated
502 ports to <code>forwarding</code>, in seconds. By default, the
503 forwarding delay is 15 seconds.
507 <group title="Other Features">
508 <column name="datapath_type">
509 Name of datapath provider. The kernel datapath has
510 type <code>system</code>. The userspace datapath has
511 type <code>netdev</code>.
514 <column name="external_ids" key="bridge-id">
515 A unique identifier of the bridge. On Citrix XenServer this will
516 commonly be the same as
517 <ref column="external_ids" key="xs-network-uuids"/>.
520 <column name="external_ids" key="xs-network-uuids">
521 Semicolon-delimited set of universally unique identifier(s) for the
522 network with which this bridge is associated on a Citrix XenServer
523 host. The network identifiers are RFC 4122 UUIDs as displayed by,
524 e.g., <code>xe network-list</code>.
527 <column name="other_config" key="hwaddr">
528 An Ethernet address in the form
529 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
530 to set the hardware address of the local port and influence the
534 <column name="other_config" key="flow-eviction-threshold"
535 type='{"type": "integer", "minInteger": 0}'>
537 A number of flows as a nonnegative integer. This sets number of
538 flows at which eviction from the kernel flow table will be triggered.
539 If there are a large number of flows then increasing this value to
540 around the number of flows present can result in reduced CPU usage
544 The default is 1000. Values below 100 will be rounded up to 100.
548 <column name="other_config" key="forward-bpdu"
549 type='{"type": "boolean"}'>
550 Option to allow forwarding of BPDU frames when NORMAL action is
551 invoked. Frames with reserved Ethernet addresses (e.g. STP
552 BPDU) will be forwarded when this option is enabled and the
553 switch is not providing that functionality. If STP is enabled
554 on the port, STP BPDUs will never be forwarded. If the Open
555 vSwitch bridge is used to connect different Ethernet networks,
556 and if Open vSwitch node does not run STP, then this option
557 should be enabled. Default is disabled, set to
558 <code>true</code> to enable.
560 The following destination MAC addresss will not be forwarded when this
563 <dt><code>01:80:c2:00:00:00</code></dt>
564 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
566 <dt><code>01:80:c2:00:00:01</code></dt>
567 <dd>IEEE Pause frame.</dd>
569 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
570 <dd>Other reserved protocols.</dd>
572 <dt><code>00:00:5e:00:01:<var>x</var><var>x</var></code></dt>
573 <dd> VRRP IPv4 virtual router MAC address. </dd>
575 <dt><code>00:00:5e:00:02:<var>x</var><var>x</var></code></dt>
576 <dd> VRRP IPv6 virtual router MAC address. </dd>
578 <dt><code>00:00:0c:07:ac:<var>x</var><var>x</var></code></dt>
579 <dd> HSRP Version 1. </dd>
581 <dt><code>00:00:0c:9f:f<var>x</var>:<var>x</var><var>x</var></code>
583 <dd> HSRP Version 2. </dd>
585 <dt><code>00:07:b4:<var>x</var><var>x</var>:<var>x</var><var>x</var>:<var>x</var><var>x</var></code></dt>
588 <dt><code>01:00:0c:cc:cc:cc</code></dt>
590 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
591 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
595 <dt><code>01:00:0c:cc:cc:cd</code></dt>
596 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
598 <dt><code>01:00:0c:cd:cd:cd</code></dt>
599 <dd>Cisco STP Uplink Fast.</dd>
601 <dt><code>01:00:0c:00:00:00</code></dt>
602 <dd>Cisco Inter Switch Link.</dd>
606 <column name="other_config" key="mac-aging-time"
607 type='{"type": "integer", "minInteger": 1}'>
609 The maximum number of seconds to retain a MAC learning entry for
610 which no packets have been seen. The default is currently 300
611 seconds (5 minutes). The value, if specified, is forced into a
612 reasonable range, currently 15 to 3600 seconds.
616 A short MAC aging time allows a network to more quickly detect that a
617 host is no longer connected to a switch port. However, it also makes
618 it more likely that packets will be flooded unnecessarily, when they
619 are addressed to a connected host that rarely transmits packets. To
620 reduce the incidence of unnecessary flooding, use a MAC aging time
621 longer than the maximum interval at which a host will ordinarily
627 <group title="Bridge Status">
629 Status information about bridges.
631 <column name="status">
632 Key-value pairs that report bridge status.
634 <column name="status" key="stp_bridge_id">
636 The bridge-id (in hex) used in spanning tree advertisements.
637 Configuring the bridge-id is described in the
638 <code>stp-system-id</code> and <code>stp-priority</code> keys
639 of the <code>other_config</code> section earlier.
642 <column name="status" key="stp_designated_root">
644 The designated root (in hex) for this spanning tree.
647 <column name="status" key="stp_root_path_cost">
649 The path cost of reaching the designated bridge. A lower
655 <group title="Common Columns">
656 The overall purpose of these columns is described under <code>Common
657 Columns</code> at the beginning of this document.
659 <column name="other_config"/>
660 <column name="external_ids"/>
664 <table name="Port" table="Port or bond configuration.">
665 <p>A port within a <ref table="Bridge"/>.</p>
666 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
667 <ref column="interfaces"/> column. Such a port logically
668 corresponds to a port on a physical Ethernet switch. A port
669 with more than one interface is a ``bonded port'' (see
670 <ref group="Bonding Configuration"/>).</p>
671 <p>Some properties that one might think as belonging to a port are actually
672 part of the port's <ref table="Interface"/> members.</p>
675 Port name. Should be alphanumeric and no more than about 8
676 bytes long. May be the same as the interface name, for
677 non-bonded ports. Must otherwise be unique among the names of
678 ports, interfaces, and bridges on a host.
681 <column name="interfaces">
682 The port's interfaces. If there is more than one, this is a
686 <group title="VLAN Configuration">
687 <p>Bridge ports support the following types of VLAN configuration:</p>
692 A trunk port carries packets on one or more specified VLANs
693 specified in the <ref column="trunks"/> column (often, on every
694 VLAN). A packet that ingresses on a trunk port is in the VLAN
695 specified in its 802.1Q header, or VLAN 0 if the packet has no
696 802.1Q header. A packet that egresses through a trunk port will
697 have an 802.1Q header if it has a nonzero VLAN ID.
701 Any packet that ingresses on a trunk port tagged with a VLAN that
702 the port does not trunk is dropped.
709 An access port carries packets on exactly one VLAN specified in the
710 <ref column="tag"/> column. Packets egressing on an access port
711 have no 802.1Q header.
715 Any packet with an 802.1Q header with a nonzero VLAN ID that
716 ingresses on an access port is dropped, regardless of whether the
717 VLAN ID in the header is the access port's VLAN ID.
721 <dt>native-tagged</dt>
723 A native-tagged port resembles a trunk port, with the exception that
724 a packet without an 802.1Q header that ingresses on a native-tagged
725 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
729 <dt>native-untagged</dt>
731 A native-untagged port resembles a native-tagged port, with the
732 exception that a packet that egresses on a native-untagged port in
733 the native VLAN will not have an 802.1Q header.
737 A packet will only egress through bridge ports that carry the VLAN of
738 the packet, as described by the rules above.
741 <column name="vlan_mode">
743 The VLAN mode of the port, as described above. When this column is
744 empty, a default mode is selected as follows:
748 If <ref column="tag"/> contains a value, the port is an access
749 port. The <ref column="trunks"/> column should be empty.
752 Otherwise, the port is a trunk port. The <ref column="trunks"/>
753 column value is honored if it is present.
760 For an access port, the port's implicitly tagged VLAN. For a
761 native-tagged or native-untagged port, the port's native VLAN. Must
762 be empty if this is a trunk port.
766 <column name="trunks">
768 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
769 or VLANs that this port trunks; if it is empty, then the port trunks
770 all VLANs. Must be empty if this is an access port.
773 A native-tagged or native-untagged port always trunks its native
774 VLAN, regardless of whether <ref column="trunks"/> includes that
779 <column name="other_config" key="priority-tags"
780 type='{"type": "boolean"}'>
782 An 802.1Q header contains two important pieces of information: a VLAN
783 ID and a priority. A frame with a zero VLAN ID, called a
784 ``priority-tagged'' frame, is supposed to be treated the same way as
785 a frame without an 802.1Q header at all (except for the priority).
789 However, some network elements ignore any frame that has 802.1Q
790 header at all, even when the VLAN ID is zero. Therefore, by default
791 Open vSwitch does not output priority-tagged frames, instead omitting
792 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
793 <code>true</code> to enable priority-tagged frames on a port.
797 Regardless of this setting, Open vSwitch omits the 802.1Q header on
798 output if both the VLAN ID and priority would be zero.
802 All frames output to native-tagged ports have a nonzero VLAN ID, so
803 this setting is not meaningful on native-tagged ports.
808 <group title="Bonding Configuration">
809 <p>A port that has more than one interface is a ``bonded port.'' Bonding
810 allows for load balancing and fail-over. Some kinds of bonding will
811 work with any kind of upstream switch:</p>
814 <dt><code>balance-slb</code></dt>
816 Balances flows among slaves based on source MAC address and output
817 VLAN, with periodic rebalancing as traffic patterns change.
820 <dt><code>active-backup</code></dt>
822 Assigns all flows to one slave, failing over to a backup slave when
823 the active slave is disabled.
828 The following modes require the upstream switch to support 802.3ad with
829 successful LACP negotiation:
833 <dt><code>balance-tcp</code></dt>
835 Balances flows among slaves based on L2, L3, and L4 protocol
836 information such as destination MAC address, IP address, and TCP
840 <dt><code>stable</code></dt>
842 <p>Attempts to always assign a given flow to the same slave
843 consistently. In an effort to maintain stability, no load
844 balancing is done. Uses a similar hashing strategy to
845 <code>balance-tcp</code>, always taking into account L3 and L4
846 fields even if LACP negotiations are unsuccessful. </p>
847 <p>Slave selection decisions are made based on <ref table="Interface"
848 column="other_config" key="bond-stable-id"/> if set. Otherwise,
849 OpenFlow port number is used. Decisions are consistent across all
850 <code>ovs-vswitchd</code> instances with equivalent
851 <ref table="Interface" column="other_config" key="bond-stable-id"/>
856 <p>These columns apply only to bonded ports. Their values are
857 otherwise ignored.</p>
859 <column name="bond_mode">
860 <p>The type of bonding used for a bonded port. Defaults to
861 <code>active-backup</code> if unset.
865 <column name="other_config" key="bond-hash-basis"
866 type='{"type": "integer"}'>
867 An integer hashed along with flows when choosing output slaves in load
868 balanced bonds. When changed, all flows will be assigned different
869 hash values possibly causing slave selection decisions to change. Does
870 not affect bonding modes which do not employ load balancing such as
871 <code>active-backup</code>.
874 <group title="Link Failure Detection">
876 An important part of link bonding is detecting that links are down so
877 that they may be disabled. These settings determine how Open vSwitch
878 detects link failure.
881 <column name="other_config" key="bond-detect-mode"
882 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
883 The means used to detect link failures. Defaults to
884 <code>carrier</code> which uses each interface's carrier to detect
885 failures. When set to <code>miimon</code>, will check for failures
886 by polling each interface's MII.
889 <column name="other_config" key="bond-miimon-interval"
890 type='{"type": "integer"}'>
891 The interval, in milliseconds, between successive attempts to poll
892 each interface's MII. Relevant only when <ref column="other_config"
893 key="bond-detect-mode"/> is <code>miimon</code>.
896 <column name="bond_updelay">
898 The number of milliseconds for which carrier must stay up on an
899 interface before the interface is considered to be up. Specify
900 <code>0</code> to enable the interface immediately.
904 This setting is honored only when at least one bonded interface is
905 already enabled. When no interfaces are enabled, then the first
906 bond interface to come up is enabled immediately.
910 <column name="bond_downdelay">
911 The number of milliseconds for which carrier must stay down on an
912 interface before the interface is considered to be down. Specify
913 <code>0</code> to disable the interface immediately.
917 <group title="LACP Configuration">
919 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
920 allows switches to automatically detect that they are connected by
921 multiple links and aggregate across those links. These settings
922 control LACP behavior.
926 Configures LACP on this port. LACP allows directly connected
927 switches to negotiate which links may be bonded. LACP may be enabled
928 on non-bonded ports for the benefit of any switches they may be
929 connected to. <code>active</code> ports are allowed to initiate LACP
930 negotiations. <code>passive</code> ports are allowed to participate
931 in LACP negotiations initiated by a remote switch, but not allowed to
932 initiate such negotiations themselves. If LACP is enabled on a port
933 whose partner switch does not support LACP, the bond will be
934 disabled. Defaults to <code>off</code> if unset.
937 <column name="other_config" key="lacp-system-id">
938 The LACP system ID of this <ref table="Port"/>. The system ID of a
939 LACP bond is used to identify itself to its partners. Must be a
940 nonzero MAC address. Defaults to the bridge Ethernet address if
944 <column name="other_config" key="lacp-system-priority"
945 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
946 The LACP system priority of this <ref table="Port"/>. In LACP
947 negotiations, link status decisions are made by the system with the
948 numerically lower priority.
951 <column name="other_config" key="lacp-time"
952 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
954 The LACP timing which should be used on this <ref table="Port"/>.
955 By default <code>slow</code> is used. When configured to be
956 <code>fast</code> LACP heartbeats are requested at a rate of once
957 per second causing connectivity problems to be detected more
958 quickly. In <code>slow</code> mode, heartbeats are requested at a
959 rate of once every 30 seconds.
964 <group title="SLB Configuration">
966 These settings control behavior when a bond is in
967 <code>balance-slb</code> mode, regardless of whether the bond was
968 intentionally configured in SLB mode or it fell back to SLB mode
969 because LACP negotiation failed.
972 <column name="other_config" key="bond-rebalance-interval"
973 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
974 For a load balanced bonded port, the number of milliseconds between
975 successive attempts to rebalance the bond, that is, to move flows
976 from one interface on the bond to another in an attempt to keep usage
977 of each interface roughly equal. If zero, load balancing is disabled
978 on the bond (carrier status changes still cause flows to move). If
979 less than 1000ms, the rebalance interval will be 1000ms.
983 <column name="bond_fake_iface">
984 For a bonded port, whether to create a fake internal interface with the
985 name of the port. Use only for compatibility with legacy software that
990 <group title="Spanning Tree Configuration">
991 <column name="other_config" key="stp-enable"
992 type='{"type": "boolean"}'>
993 If spanning tree is enabled on the bridge, member ports are
994 enabled by default (with the exception of bond, internal, and
995 mirror ports which do not work with STP). If this column's
996 value is <code>false</code> spanning tree is disabled on the
1000 <column name="other_config" key="stp-port-num"
1001 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1002 The port number used for the lower 8 bits of the port-id. By
1003 default, the numbers will be assigned automatically. If any
1004 port's number is manually configured on a bridge, then they
1008 <column name="other_config" key="stp-port-priority"
1009 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1010 The port's relative priority value for determining the root
1011 port (the upper 8 bits of the port-id). A port with a lower
1012 port-id will be chosen as the root port. By default, the
1016 <column name="other_config" key="stp-path-cost"
1017 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1018 Spanning tree path cost for the port. A lower number indicates
1019 a faster link. By default, the cost is based on the maximum
1024 <group title="Other Features">
1026 Quality of Service configuration for this port.
1030 The MAC address to use for this port for the purpose of choosing the
1031 bridge's MAC address. This column does not necessarily reflect the
1032 port's actual MAC address, nor will setting it change the port's actual
1036 <column name="fake_bridge">
1037 Does this port represent a sub-bridge for its tagged VLAN within the
1038 Bridge? See ovs-vsctl(8) for more information.
1041 <column name="external_ids" key="fake-bridge-id-*">
1042 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1043 column) are defined by prefixing a <ref table="Bridge"/> <ref
1044 table="Bridge" column="external_ids"/> key with
1045 <code>fake-bridge-</code>,
1046 e.g. <code>fake-bridge-xs-network-uuids</code>.
1050 <group title="Port Status">
1052 Status information about ports attached to bridges.
1054 <column name="status">
1055 Key-value pairs that report port status.
1057 <column name="status" key="stp_port_id">
1059 The port-id (in hex) used in spanning tree advertisements for
1060 this port. Configuring the port-id is described in the
1061 <code>stp-port-num</code> and <code>stp-port-priority</code>
1062 keys of the <code>other_config</code> section earlier.
1065 <column name="status" key="stp_state"
1066 type='{"type": "string", "enum": ["set",
1067 ["disabled", "listening", "learning",
1068 "forwarding", "blocking"]]}'>
1070 STP state of the port.
1073 <column name="status" key="stp_sec_in_state"
1074 type='{"type": "integer", "minInteger": 0}'>
1076 The amount of time (in seconds) port has been in the current
1080 <column name="status" key="stp_role"
1081 type='{"type": "string", "enum": ["set",
1082 ["root", "designated", "alternate"]]}'>
1084 STP role of the port.
1089 <group title="Port Statistics">
1091 Key-value pairs that report port statistics.
1093 <group title="Statistics: STP transmit and receive counters">
1094 <column name="statistics" key="stp_tx_count">
1095 Number of STP BPDUs sent on this port by the spanning
1098 <column name="statistics" key="stp_rx_count">
1099 Number of STP BPDUs received on this port and accepted by the
1100 spanning tree library.
1102 <column name="statistics" key="stp_error_count">
1103 Number of bad STP BPDUs received on this port. Bad BPDUs
1104 include runt packets and those with an unexpected protocol ID.
1109 <group title="Common Columns">
1110 The overall purpose of these columns is described under <code>Common
1111 Columns</code> at the beginning of this document.
1113 <column name="other_config"/>
1114 <column name="external_ids"/>
1118 <table name="Interface" title="One physical network device in a Port.">
1119 An interface within a <ref table="Port"/>.
1121 <group title="Core Features">
1122 <column name="name">
1123 Interface name. Should be alphanumeric and no more than about 8 bytes
1124 long. May be the same as the port name, for non-bonded ports. Must
1125 otherwise be unique among the names of ports, interfaces, and bridges
1130 <p>Ethernet address to set for this interface. If unset then the
1131 default MAC address is used:</p>
1133 <li>For the local interface, the default is the lowest-numbered MAC
1134 address among the other bridge ports, either the value of the
1135 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1136 if set, or its actual MAC (for bonded ports, the MAC of its slave
1137 whose name is first in alphabetical order). Internal ports and
1138 bridge ports that are used as port mirroring destinations (see the
1139 <ref table="Mirror"/> table) are ignored.</li>
1140 <li>For other internal interfaces, the default MAC is randomly
1142 <li>External interfaces typically have a MAC address associated with
1143 their hardware.</li>
1145 <p>Some interfaces may not have a software-controllable MAC
1149 <column name="ofport">
1150 <p>OpenFlow port number for this interface. Unlike most columns, this
1151 column's value should be set only by Open vSwitch itself. Other
1152 clients should set this column to an empty set (the default) when
1153 creating an <ref table="Interface"/>.</p>
1154 <p>Open vSwitch populates this column when the port number becomes
1155 known. If the interface is successfully added,
1156 <ref column="ofport"/> will be set to a number between 1 and 65535
1157 (generally either in the range 1 to 65279, inclusive, or 65534, the
1158 port number for the OpenFlow ``local port''). If the interface
1159 cannot be added then Open vSwitch sets this column
1164 <group title="System-Specific Details">
1165 <column name="type">
1167 The interface type, one of:
1171 <dt><code>system</code></dt>
1172 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1173 Sometimes referred to as ``external interfaces'' since they are
1174 generally connected to hardware external to that on which the Open
1175 vSwitch is running. The empty string is a synonym for
1176 <code>system</code>.</dd>
1178 <dt><code>internal</code></dt>
1179 <dd>A simulated network device that sends and receives traffic. An
1180 internal interface whose <ref column="name"/> is the same as its
1181 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1182 ``local interface.'' It does not make sense to bond an internal
1183 interface, so the terms ``port'' and ``interface'' are often used
1184 imprecisely for internal interfaces.</dd>
1186 <dt><code>tap</code></dt>
1187 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1189 <dt><code>gre</code></dt>
1191 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1192 tunnel. See <ref group="Tunnel Options"/> for information on
1193 configuring GRE tunnels.
1196 <dt><code>ipsec_gre</code></dt>
1198 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1202 <dt><code>capwap</code></dt>
1204 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1205 5415). This allows interoperability with certain switches that do
1206 not support GRE. Only the tunneling component of the protocol is
1207 implemented. UDP ports 58881 and 58882 are used as the source and
1208 destination ports respectively. CAPWAP is currently supported only
1209 with the Linux kernel datapath with kernel version 2.6.26 or later.
1212 <dt><code>patch</code></dt>
1214 A pair of virtual devices that act as a patch cable.
1217 <dt><code>null</code></dt>
1218 <dd>An ignored interface.</dd>
1223 <group title="Tunnel Options">
1225 These options apply to interfaces with <ref column="type"/> of
1226 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1230 Each tunnel must be uniquely identified by the combination of <ref
1231 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1232 column="options" key="local_ip"/>, and <ref column="options"
1233 key="in_key"/>. If two ports are defined that are the same except one
1234 has an optional identifier and the other does not, the more specific
1235 one is matched first. <ref column="options" key="in_key"/> is
1236 considered more specific than <ref column="options" key="local_ip"/> if
1237 a port defines one and another port defines the other.
1240 <column name="options" key="remote_ip">
1242 Required. The tunnel endpoint. Unicast and multicast endpoints are
1247 When a multicast endpoint is specified, a routing table lookup occurs
1248 only when the tunnel is created. Following a routing change, delete
1249 and then re-create the tunnel to force a new routing table lookup.
1253 <column name="options" key="local_ip">
1254 Optional. The destination IP that received packets must match.
1255 Default is to match all addresses. Must be omitted when <ref
1256 column="options" key="remote_ip"/> is a multicast address.
1259 <column name="options" key="in_key">
1260 <p>Optional. The key that received packets must contain, one of:</p>
1264 <code>0</code>. The tunnel receives packets with no key or with a
1265 key of 0. This is equivalent to specifying no <ref column="options"
1266 key="in_key"/> at all.
1269 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1270 tunnel receives only packets with the specified key.
1273 The word <code>flow</code>. The tunnel accepts packets with any
1274 key. The key will be placed in the <code>tun_id</code> field for
1275 matching in the flow table. The <code>ovs-ofctl</code> manual page
1276 contains additional information about matching fields in OpenFlow
1285 <column name="options" key="out_key">
1286 <p>Optional. The key to be set on outgoing packets, one of:</p>
1290 <code>0</code>. Packets sent through the tunnel will have no key.
1291 This is equivalent to specifying no <ref column="options"
1292 key="out_key"/> at all.
1295 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1296 sent through the tunnel will have the specified key.
1299 The word <code>flow</code>. Packets sent through the tunnel will
1300 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1301 vendor extension (0 is used in the absence of an action). The
1302 <code>ovs-ofctl</code> manual page contains additional information
1303 about the Nicira OpenFlow vendor extensions.
1308 <column name="options" key="key">
1309 Optional. Shorthand to set <code>in_key</code> and
1310 <code>out_key</code> at the same time.
1313 <column name="options" key="tos">
1314 Optional. The value of the ToS bits to be set on the encapsulating
1315 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1316 zero. It may also be the word <code>inherit</code>, in which case
1317 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1318 (otherwise it will be 0). The ECN fields are always inherited.
1322 <column name="options" key="ttl">
1323 Optional. The TTL to be set on the encapsulating packet. It may also
1324 be the word <code>inherit</code>, in which case the TTL will be copied
1325 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1326 system default, typically 64). Default is the system default TTL.
1329 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1330 Optional. If enabled, the Don't Fragment bit will be copied from the
1331 inner IP headers (those of the encapsulated traffic) to the outer
1332 (tunnel) headers. Default is disabled; set to <code>true</code> to
1336 <column name="options" key="df_default"
1337 type='{"type": "boolean"}'>
1338 Optional. If enabled, the Don't Fragment bit will be set by default on
1339 tunnel headers if the <code>df_inherit</code> option is not set, or if
1340 the encapsulated packet is not IP. Default is enabled; set to
1341 <code>false</code> to disable.
1344 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1345 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1346 Destination Unreachable - Fragmentation Needed'' messages will be
1347 generated for IPv4 packets with the DF bit set and IPv6 packets above
1348 the minimum MTU if the packet size exceeds the path MTU minus the size
1349 of the tunnel headers. Note that this option causes behavior that is
1350 typically reserved for routers and therefore is not entirely in
1351 compliance with the IEEE 802.1D specification for bridges. Default is
1352 enabled; set to <code>false</code> to disable.
1355 <group title="Tunnel Options: gre only">
1357 Only <code>gre</code> interfaces support these options.
1360 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1361 Enable caching of tunnel headers and the output path. This can lead
1362 to a significant performance increase without changing behavior. In
1363 general it should not be necessary to adjust this setting. However,
1364 the caching can bypass certain components of the IP stack (such as
1365 <code>iptables</code>) and it may be useful to disable it if these
1366 features are required or as a debugging measure. Default is enabled,
1367 set to <code>false</code> to disable.
1371 <group title="Tunnel Options: gre and ipsec_gre only">
1373 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1377 <column name="options" key="csum" type='{"type": "boolean"}'>
1379 Optional. Compute GRE checksums on outgoing packets. Default is
1380 disabled, set to <code>true</code> to enable. Checksums present on
1381 incoming packets will be validated regardless of this setting.
1385 GRE checksums impose a significant performance penalty because they
1386 cover the entire packet. The encapsulated L3, L4, and L7 packet
1387 contents typically have their own checksums, so this additional
1388 checksum only adds value for the GRE and encapsulated L2 headers.
1392 This option is supported for <code>ipsec_gre</code>, but not useful
1393 because GRE checksums are weaker than, and redundant with, IPsec
1394 payload authentication.
1399 <group title="Tunnel Options: ipsec_gre only">
1401 Only <code>ipsec_gre</code> interfaces support these options.
1404 <column name="options" key="peer_cert">
1405 Required for certificate authentication. A string containing the
1406 peer's certificate in PEM format. Additionally the host's
1407 certificate must be specified with the <code>certificate</code>
1411 <column name="options" key="certificate">
1412 Required for certificate authentication. The name of a PEM file
1413 containing a certificate that will be presented to the peer during
1417 <column name="options" key="private_key">
1418 Optional for certificate authentication. The name of a PEM file
1419 containing the private key associated with <code>certificate</code>.
1420 If <code>certificate</code> contains the private key, this option may
1424 <column name="options" key="psk">
1425 Required for pre-shared key authentication. Specifies a pre-shared
1426 key for authentication that must be identical on both sides of the
1432 <group title="Patch Options">
1434 Only <code>patch</code> interfaces support these options.
1437 <column name="options" key="peer">
1438 The <ref column="name"/> of the <ref table="Interface"/> for the other
1439 side of the patch. The named <ref table="Interface"/>'s own
1440 <code>peer</code> option must specify this <ref table="Interface"/>'s
1441 name. That is, the two patch interfaces must have reversed <ref
1442 column="name"/> and <code>peer</code> values.
1446 <group title="Interface Status">
1448 Status information about interfaces attached to bridges, updated every
1449 5 seconds. Not all interfaces have all of these properties; virtual
1450 interfaces don't have a link speed, for example. Non-applicable
1451 columns will have empty values.
1453 <column name="admin_state">
1455 The administrative state of the physical network link.
1459 <column name="link_state">
1461 The observed state of the physical network link. This is ordinarily
1462 the link's carrier status. If the interface's <ref table="Port"/> is
1463 a bond configured for miimon monitoring, it is instead the network
1464 link's miimon status.
1468 <column name="link_resets">
1470 The number of times Open vSwitch has observed the
1471 <ref column="link_state"/> of this <ref table="Interface"/> change.
1475 <column name="link_speed">
1477 The negotiated speed of the physical network link.
1478 Valid values are positive integers greater than 0.
1482 <column name="duplex">
1484 The duplex mode of the physical network link.
1490 The MTU (maximum transmission unit); i.e. the largest
1491 amount of data that can fit into a single Ethernet frame.
1492 The standard Ethernet MTU is 1500 bytes. Some physical media
1493 and many kinds of virtual interfaces can be configured with
1497 This column will be empty for an interface that does not
1498 have an MTU as, for example, some kinds of tunnels do not.
1502 <column name="lacp_current">
1503 Boolean value indicating LACP status for this interface. If true, this
1504 interface has current LACP information about its LACP partner. This
1505 information may be used to monitor the health of interfaces in a LACP
1506 enabled port. This column will be empty if LACP is not enabled.
1509 <column name="status">
1510 Key-value pairs that report port status. Supported status values are
1511 <ref column="type"/>-dependent; some interfaces may not have a valid
1512 <ref column="status" key="driver_name"/>, for example.
1515 <column name="status" key="driver_name">
1516 The name of the device driver controlling the network adapter.
1519 <column name="status" key="driver_version">
1520 The version string of the device driver controlling the network
1524 <column name="status" key="firmware_version">
1525 The version string of the network adapter's firmware, if available.
1528 <column name="status" key="source_ip">
1529 The source IP address used for an IPv4 tunnel end-point, such as
1530 <code>gre</code> or <code>capwap</code>.
1533 <column name="status" key="tunnel_egress_iface">
1534 Egress interface for tunnels. Currently only relevant for GRE and
1535 CAPWAP tunnels. On Linux systems, this column will show the name of
1536 the interface which is responsible for routing traffic destined for the
1537 configured <ref column="options" key="remote_ip"/>. This could be an
1538 internal interface such as a bridge port.
1541 <column name="status" key="tunnel_egress_iface_carrier"
1542 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1543 Whether carrier is detected on <ref column="status"
1544 key="tunnel_egress_iface"/>.
1548 <group title="Statistics">
1550 Key-value pairs that report interface statistics. The current
1551 implementation updates these counters periodically. Future
1552 implementations may update them when an interface is created, when they
1553 are queried (e.g. using an OVSDB <code>select</code> operation), and
1554 just before an interface is deleted due to virtual interface hot-unplug
1555 or VM shutdown, and perhaps at other times, but not on any regular
1559 These are the same statistics reported by OpenFlow in its <code>struct
1560 ofp_port_stats</code> structure. If an interface does not support a
1561 given statistic, then that pair is omitted.
1563 <group title="Statistics: Successful transmit and receive counters">
1564 <column name="statistics" key="rx_packets">
1565 Number of received packets.
1567 <column name="statistics" key="rx_bytes">
1568 Number of received bytes.
1570 <column name="statistics" key="tx_packets">
1571 Number of transmitted packets.
1573 <column name="statistics" key="tx_bytes">
1574 Number of transmitted bytes.
1577 <group title="Statistics: Receive errors">
1578 <column name="statistics" key="rx_dropped">
1579 Number of packets dropped by RX.
1581 <column name="statistics" key="rx_frame_err">
1582 Number of frame alignment errors.
1584 <column name="statistics" key="rx_over_err">
1585 Number of packets with RX overrun.
1587 <column name="statistics" key="rx_crc_err">
1588 Number of CRC errors.
1590 <column name="statistics" key="rx_errors">
1591 Total number of receive errors, greater than or equal to the sum of
1595 <group title="Statistics: Transmit errors">
1596 <column name="statistics" key="tx_dropped">
1597 Number of packets dropped by TX.
1599 <column name="statistics" key="collisions">
1600 Number of collisions.
1602 <column name="statistics" key="tx_errors">
1603 Total number of transmit errors, greater than or equal to the sum of
1609 <group title="Ingress Policing">
1611 These settings control ingress policing for packets received on this
1612 interface. On a physical interface, this limits the rate at which
1613 traffic is allowed into the system from the outside; on a virtual
1614 interface (one connected to a virtual machine), this limits the rate at
1615 which the VM is able to transmit.
1618 Policing is a simple form of quality-of-service that simply drops
1619 packets received in excess of the configured rate. Due to its
1620 simplicity, policing is usually less accurate and less effective than
1621 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1622 table="Queue"/> tables).
1625 Policing is currently implemented only on Linux. The Linux
1626 implementation uses a simple ``token bucket'' approach:
1630 The size of the bucket corresponds to <ref
1631 column="ingress_policing_burst"/>. Initially the bucket is full.
1634 Whenever a packet is received, its size (converted to tokens) is
1635 compared to the number of tokens currently in the bucket. If the
1636 required number of tokens are available, they are removed and the
1637 packet is forwarded. Otherwise, the packet is dropped.
1640 Whenever it is not full, the bucket is refilled with tokens at the
1641 rate specified by <ref column="ingress_policing_rate"/>.
1645 Policing interacts badly with some network protocols, and especially
1646 with fragmented IP packets. Suppose that there is enough network
1647 activity to keep the bucket nearly empty all the time. Then this token
1648 bucket algorithm will forward a single packet every so often, with the
1649 period depending on packet size and on the configured rate. All of the
1650 fragments of an IP packets are normally transmitted back-to-back, as a
1651 group. In such a situation, therefore, only one of these fragments
1652 will be forwarded and the rest will be dropped. IP does not provide
1653 any way for the intended recipient to ask for only the remaining
1654 fragments. In such a case there are two likely possibilities for what
1655 will happen next: either all of the fragments will eventually be
1656 retransmitted (as TCP will do), in which case the same problem will
1657 recur, or the sender will not realize that its packet has been dropped
1658 and data will simply be lost (as some UDP-based protocols will do).
1659 Either way, it is possible that no forward progress will ever occur.
1661 <column name="ingress_policing_rate">
1663 Maximum rate for data received on this interface, in kbps. Data
1664 received faster than this rate is dropped. Set to <code>0</code>
1665 (the default) to disable policing.
1669 <column name="ingress_policing_burst">
1670 <p>Maximum burst size for data received on this interface, in kb. The
1671 default burst size if set to <code>0</code> is 1000 kb. This value
1672 has no effect if <ref column="ingress_policing_rate"/>
1673 is <code>0</code>.</p>
1675 Specifying a larger burst size lets the algorithm be more forgiving,
1676 which is important for protocols like TCP that react severely to
1677 dropped packets. The burst size should be at least the size of the
1678 interface's MTU. Specifying a value that is numerically at least as
1679 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1680 closer to achieving the full rate.
1685 <group title="Connectivity Fault Management">
1687 802.1ag Connectivity Fault Management (CFM) allows a group of
1688 Maintenance Points (MPs) called a Maintenance Association (MA) to
1689 detect connectivity problems with each other. MPs within a MA should
1690 have complete and exclusive interconnectivity. This is verified by
1691 occasionally broadcasting Continuity Check Messages (CCMs) at a
1692 configurable transmission interval.
1696 According to the 802.1ag specification, each Maintenance Point should
1697 be configured out-of-band with a list of Remote Maintenance Points it
1698 should have connectivity to. Open vSwitch differs from the
1699 specification in this area. It simply assumes the link is faulted if
1700 no Remote Maintenance Points are reachable, and considers it not
1704 <column name="cfm_mpid">
1705 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1706 a Maintenance Association. The MPID is used to identify this endpoint
1707 to other Maintenance Points in the MA. Each end of a link being
1708 monitored should have a different MPID. Must be configured to enable
1709 CFM on this <ref table="Interface"/>.
1712 <column name="cfm_fault">
1714 Indicates a connectivity fault triggered by an inability to receive
1715 heartbeats from any remote endpoint. When a fault is triggered on
1716 <ref table="Interface"/>s participating in bonds, they will be
1720 Faults can be triggered for several reasons. Most importantly they
1721 are triggered when no CCMs are received for a period of 3.5 times the
1722 transmission interval. Faults are also triggered when any CCMs
1723 indicate that a Remote Maintenance Point is not receiving CCMs but
1724 able to send them. Finally, a fault is triggered if a CCM is
1725 received which indicates unexpected configuration. Notably, this
1726 case arises when a CCM is received which advertises the local MPID.
1730 <column name="cfm_fault_status" key="recv">
1731 Indicates a CFM fault was triggered due to a lack of CCMs received on
1732 the <ref table="Interface"/>.
1735 <column name="cfm_fault_status" key="rdi">
1736 Indicates a CFM fault was triggered due to the reception of a CCM with
1737 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1738 are not receiving CCMs themselves. This typically indicates a
1739 unidirectional connectivity failure.
1742 <column name="cfm_fault_status" key="maid">
1743 Indicates a CFM fault was triggered due to the reception of a CCM with
1744 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1745 with an identification number in addition to the MPID called the MAID.
1746 Open vSwitch only supports receiving CCM broadcasts tagged with the
1747 MAID it uses internally.
1750 <column name="cfm_fault_status" key="loopback">
1751 Indicates a CFM fault was triggered due to the reception of a CCM
1752 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1753 column of this <ref table="Interface"/>. This may indicate a loop in
1757 <column name="cfm_fault_status" key="overflow">
1758 Indicates a CFM fault was triggered because the CFM module received
1759 CCMs from more remote endpoints than it can keep track of.
1762 <column name="cfm_fault_status" key="override">
1763 Indicates a CFM fault was manually triggered by an administrator using
1764 an <code>ovs-appctl</code> command.
1767 <column name="cfm_fault_status" key="interval">
1768 Indicates a CFM fault was triggered due to the reception of a CCM
1769 frame having an invalid interval.
1772 <column name="cfm_health">
1774 Indicates the health of the interface as a percentage of CCM frames
1775 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1776 The health of an interface is undefined if it is communicating with
1777 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1778 healthy heartbeats are not received at the expected rate, and
1779 gradually improves as healthy heartbeats are received at the desired
1780 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1781 health of the interface is refreshed.
1784 As mentioned above, the faults can be triggered for several reasons.
1785 The link health will deteriorate even if heartbeats are received but
1786 they are reported to be unhealthy. An unhealthy heartbeat in this
1787 context is a heartbeat for which either some fault is set or is out
1788 of sequence. The interface health can be 100 only on receiving
1789 healthy heartbeats at the desired rate.
1793 <column name="cfm_remote_mpids">
1794 When CFM is properly configured, Open vSwitch will occasionally
1795 receive CCM broadcasts. These broadcasts contain the MPID of the
1796 sending Maintenance Point. The list of MPIDs from which this
1797 <ref table="Interface"/> is receiving broadcasts from is regularly
1798 collected and written to this column.
1801 <column name="other_config" key="cfm_interval"
1802 type='{"type": "integer"}'>
1804 The interval, in milliseconds, between transmissions of CFM
1805 heartbeats. Three missed heartbeat receptions indicate a
1810 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1811 60,000, or 600,000 ms are supported. Other values will be rounded
1812 down to the nearest value on the list. Extended mode (see <ref
1813 column="other_config" key="cfm_extended"/>) supports any interval up
1814 to 65,535 ms. In either mode, the default is 1000 ms.
1817 <p>We do not recommend using intervals less than 100 ms.</p>
1820 <column name="other_config" key="cfm_extended"
1821 type='{"type": "boolean"}'>
1822 When <code>true</code>, the CFM module operates in extended mode. This
1823 causes it to use a nonstandard destination address to avoid conflicting
1824 with compliant implementations which may be running concurrently on the
1825 network. Furthermore, extended mode increases the accuracy of the
1826 <code>cfm_interval</code> configuration parameter by breaking wire
1827 compatibility with 802.1ag compliant implementations. Defaults to
1830 <column name="other_config" key="cfm_opstate"
1831 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1832 When <code>down</code>, the CFM module marks all CCMs it generates as
1833 operationally down without triggering a fault. This allows remote
1834 maintenance points to choose not to forward traffic to the
1835 <ref table="Interface"/> on which this CFM module is running.
1836 Currently, in Open vSwitch, the opdown bit of CCMs affects
1837 <ref table="Interface"/>s participating in bonds, and the bundle
1838 OpenFlow action. This setting is ignored when CFM is not in extended
1839 mode. Defaults to <code>up</code>.
1842 <column name="other_config" key="cfm_ccm_vlan"
1843 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1844 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1845 with the given value. May be the string <code>random</code> in which
1846 case each CCM will be tagged with a different randomly generated VLAN.
1849 <column name="other_config" key="cfm_ccm_pcp"
1850 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1851 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1852 with the given PCP value. The VLAN ID of the tag is governed by the
1853 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1854 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1860 <group title="Bonding Configuration">
1861 <column name="other_config" key="bond-stable-id"
1862 type='{"type": "integer", "minInteger": 1}'>
1863 Used in <code>stable</code> bond mode to make slave
1864 selection decisions. Allocating <ref column="other_config"
1865 key="bond-stable-id"/> values consistently across interfaces
1866 participating in a bond will guarantee consistent slave selection
1867 decisions across <code>ovs-vswitchd</code> instances when using
1868 <code>stable</code> bonding mode.
1871 <column name="other_config" key="lacp-port-id"
1872 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1873 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1874 used in LACP negotiations to identify individual ports
1875 participating in a bond.
1878 <column name="other_config" key="lacp-port-priority"
1879 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1880 The LACP port priority of this <ref table="Interface"/>. In LACP
1881 negotiations <ref table="Interface"/>s with numerically lower
1882 priorities are preferred for aggregation.
1885 <column name="other_config" key="lacp-aggregation-key"
1886 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1887 The LACP aggregation key of this <ref table="Interface"/>. <ref
1888 table="Interface"/>s with different aggregation keys may not be active
1889 within a given <ref table="Port"/> at the same time.
1893 <group title="Virtual Machine Identifiers">
1895 These key-value pairs specifically apply to an interface that
1896 represents a virtual Ethernet interface connected to a virtual
1897 machine. These key-value pairs should not be present for other types
1898 of interfaces. Keys whose names end in <code>-uuid</code> have
1899 values that uniquely identify the entity in question. For a Citrix
1900 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1901 Other hypervisors may use other formats.
1904 <column name="external_ids" key="attached-mac">
1905 The MAC address programmed into the ``virtual hardware'' for this
1906 interface, in the form
1907 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1908 For Citrix XenServer, this is the value of the <code>MAC</code> field
1909 in the VIF record for this interface.
1912 <column name="external_ids" key="iface-id">
1913 A system-unique identifier for the interface. On XenServer, this will
1914 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1917 <column name="external_ids" key="iface-status"
1918 type='{"type": "string",
1919 "enum": ["set", ["active", "inactive"]]}'>
1921 Hypervisors may sometimes have more than one interface associated
1922 with a given <ref column="external_ids" key="iface-id"/>, only one of
1923 which is actually in use at a given time. For example, in some
1924 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1925 for a single <ref column="external_ids" key="iface-id"/>, but only
1926 uses one of them at a time. A hypervisor that behaves this way must
1927 mark the currently in use interface <code>active</code> and the
1928 others <code>inactive</code>. A hypervisor that never has more than
1929 one interface for a given <ref column="external_ids" key="iface-id"/>
1930 may mark that interface <code>active</code> or omit <ref
1931 column="external_ids" key="iface-status"/> entirely.
1935 During VM migration, a given <ref column="external_ids"
1936 key="iface-id"/> might transiently be marked <code>active</code> on
1937 two different hypervisors. That is, <code>active</code> means that
1938 this <ref column="external_ids" key="iface-id"/> is the active
1939 instance within a single hypervisor, not in a broader scope.
1943 <column name="external_ids" key="xs-vif-uuid">
1944 The virtual interface associated with this interface.
1947 <column name="external_ids" key="xs-network-uuid">
1948 The virtual network to which this interface is attached.
1951 <column name="external_ids" key="vm-id">
1952 The VM to which this interface belongs. On XenServer, this will be the
1953 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1956 <column name="external_ids" key="xs-vm-uuid">
1957 The VM to which this interface belongs.
1961 <group title="VLAN Splinters">
1963 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1964 with buggy network drivers in old versions of Linux that do not
1965 properly support VLANs when VLAN devices are not used, at some cost
1966 in memory and performance.
1970 When VLAN splinters are enabled on a particular interface, Open vSwitch
1971 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1972 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1973 received on the VLAN device is treated as if it had been received on
1974 the interface on the particular VLAN.
1978 VLAN splinters consider a VLAN to be in use if:
1983 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1984 table="Port"/> record.
1988 The VLAN is listed within the <ref table="Port" column="trunks"/>
1989 column of the <ref table="Port"/> record of an interface on which
1990 VLAN splinters are enabled.
1992 An empty <ref table="Port" column="trunks"/> does not influence the
1993 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1994 will exceed the current 1,024 port per datapath limit.
1998 An OpenFlow flow within any bridge matches the VLAN.
2003 The same set of in-use VLANs applies to every interface on which VLAN
2004 splinters are enabled. That is, the set is not chosen separately for
2005 each interface but selected once as the union of all in-use VLANs based
2010 It does not make sense to enable VLAN splinters on an interface for an
2011 access port, or on an interface that is not a physical port.
2015 VLAN splinters are deprecated. When broken device drivers are no
2016 longer in widespread use, we will delete this feature.
2019 <column name="other_config" key="enable-vlan-splinters"
2020 type='{"type": "boolean"}'>
2022 Set to <code>true</code> to enable VLAN splinters on this interface.
2023 Defaults to <code>false</code>.
2027 VLAN splinters increase kernel and userspace memory overhead, so do
2028 not use them unless they are needed.
2032 VLAN splinters do not support 802.1p priority tags. Received
2033 priorities will appear to be 0, regardless of their actual values,
2034 and priorities on transmitted packets will also be cleared to 0.
2039 <group title="Common Columns">
2040 The overall purpose of these columns is described under <code>Common
2041 Columns</code> at the beginning of this document.
2043 <column name="other_config"/>
2044 <column name="external_ids"/>
2048 <table name="Flow_Table" title="OpenFlow table configuration">
2049 <p>Configuration for a particular OpenFlow table.</p>
2051 <column name="name">
2052 The table's name. Set this column to change the name that controllers
2053 will receive when they request table statistics, e.g. <code>ovs-ofctl
2054 dump-tables</code>. The name does not affect switch behavior.
2057 <column name="flow_limit">
2058 If set, limits the number of flows that may be added to the table. Open
2059 vSwitch may limit the number of flows in a table for other reasons,
2060 e.g. due to hardware limitations or for resource availability or
2061 performance reasons.
2064 <column name="overflow_policy">
2066 Controls the switch's behavior when an OpenFlow flow table modification
2067 request would add flows in excess of <ref column="flow_limit"/>. The
2068 supported values are:
2072 <dt><code>refuse</code></dt>
2074 Refuse to add the flow or flows. This is also the default policy
2075 when <ref column="overflow_policy"/> is unset.
2078 <dt><code>evict</code></dt>
2080 Delete the flow that will expire soonest. See <ref column="groups"/>
2086 <column name="groups">
2088 When <ref column="overflow_policy"/> is <code>evict</code>, this
2089 controls how flows are chosen for eviction when the flow table would
2090 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2091 of NXM fields or sub-fields, each of which takes one of the forms
2092 <code><var>field</var>[]</code> or
2093 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2094 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2095 <code>nicira-ext.h</code> for a complete list of NXM field names.
2099 When a flow must be evicted due to overflow, the flow to evict is
2100 chosen through an approximation of the following algorithm:
2105 Divide the flows in the table into groups based on the values of the
2106 specified fields or subfields, so that all of the flows in a given
2107 group have the same values for those fields. If a flow does not
2108 specify a given field, that field's value is treated as 0.
2112 Consider the flows in the largest group, that is, the group that
2113 contains the greatest number of flows. If two or more groups all
2114 have the same largest number of flows, consider the flows in all of
2119 Among the flows under consideration, choose the flow that expires
2120 soonest for eviction.
2125 The eviction process only considers flows that have an idle timeout or
2126 a hard timeout. That is, eviction never deletes permanent flows.
2127 (Permanent flows do count against <ref column="flow_limit"/>.
2131 Open vSwitch ignores any invalid or unknown field specifications.
2135 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2136 column has no effect.
2141 <table name="QoS" title="Quality of Service configuration">
2142 <p>Quality of Service (QoS) configuration for each Port that
2145 <column name="type">
2146 <p>The type of QoS to implement. The currently defined types are
2149 <dt><code>linux-htb</code></dt>
2151 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2152 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2153 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2154 for information on how this classifier works and how to configure it.
2158 <dt><code>linux-hfsc</code></dt>
2160 Linux "Hierarchical Fair Service Curve" classifier.
2161 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2162 information on how this classifier works.
2167 <column name="queues">
2168 <p>A map from queue numbers to <ref table="Queue"/> records. The
2169 supported range of queue numbers depend on <ref column="type"/>. The
2170 queue numbers are the same as the <code>queue_id</code> used in
2171 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2175 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2176 actions when no specific queue has been set. When no configuration for
2177 queue 0 is present, it is automatically configured as if a <ref
2178 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2179 and <ref table="Queue" column="other_config"/> columns had been
2181 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2182 this case. With some queuing disciplines, this dropped all packets
2183 destined for the default queue.)
2187 <group title="Configuration for linux-htb and linux-hfsc">
2189 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2190 the following key-value pair:
2193 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2194 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2195 specified, for physical interfaces, the default is the link rate. For
2196 other interfaces or if the link rate cannot be determined, the default
2197 is currently 100 Mbps.
2201 <group title="Common Columns">
2202 The overall purpose of these columns is described under <code>Common
2203 Columns</code> at the beginning of this document.
2205 <column name="other_config"/>
2206 <column name="external_ids"/>
2210 <table name="Queue" title="QoS output queue.">
2211 <p>A configuration for a port output queue, used in configuring Quality of
2212 Service (QoS) features. May be referenced by <ref column="queues"
2213 table="QoS"/> column in <ref table="QoS"/> table.</p>
2215 <column name="dscp">
2216 If set, Open vSwitch will mark all traffic egressing this
2217 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2218 default <ref table="Queue"/> is only marked if it was explicitly selected
2219 as the <ref table="Queue"/> at the time the packet was output. If unset,
2220 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2224 <group title="Configuration for linux-htb QoS">
2226 <ref table="QoS"/> <ref table="QoS" column="type"/>
2227 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2228 It has the following key-value pairs defined.
2231 <column name="other_config" key="min-rate"
2232 type='{"type": "integer", "minInteger": 1}'>
2233 Minimum guaranteed bandwidth, in bit/s.
2236 <column name="other_config" key="max-rate"
2237 type='{"type": "integer", "minInteger": 1}'>
2238 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2239 queue's rate will not be allowed to exceed the specified value, even
2240 if excess bandwidth is available. If unspecified, defaults to no
2244 <column name="other_config" key="burst"
2245 type='{"type": "integer", "minInteger": 1}'>
2246 Burst size, in bits. This is the maximum amount of ``credits'' that a
2247 queue can accumulate while it is idle. Optional. Details of the
2248 <code>linux-htb</code> implementation require a minimum burst size, so
2249 a too-small <code>burst</code> will be silently ignored.
2252 <column name="other_config" key="priority"
2253 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2254 A queue with a smaller <code>priority</code> will receive all the
2255 excess bandwidth that it can use before a queue with a larger value
2256 receives any. Specific priority values are unimportant; only relative
2257 ordering matters. Defaults to 0 if unspecified.
2261 <group title="Configuration for linux-hfsc QoS">
2263 <ref table="QoS"/> <ref table="QoS" column="type"/>
2264 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2265 It has the following key-value pairs defined.
2268 <column name="other_config" key="min-rate"
2269 type='{"type": "integer", "minInteger": 1}'>
2270 Minimum guaranteed bandwidth, in bit/s.
2273 <column name="other_config" key="max-rate"
2274 type='{"type": "integer", "minInteger": 1}'>
2275 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2276 queue's rate will not be allowed to exceed the specified value, even if
2277 excess bandwidth is available. If unspecified, defaults to no
2282 <group title="Common Columns">
2283 The overall purpose of these columns is described under <code>Common
2284 Columns</code> at the beginning of this document.
2286 <column name="other_config"/>
2287 <column name="external_ids"/>
2291 <table name="Mirror" title="Port mirroring.">
2292 <p>A port mirror within a <ref table="Bridge"/>.</p>
2293 <p>A port mirror configures a bridge to send selected frames to special
2294 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2295 traffic may also be referred to as SPAN or RSPAN, depending on how
2296 the mirrored traffic is sent.</p>
2298 <column name="name">
2299 Arbitrary identifier for the <ref table="Mirror"/>.
2302 <group title="Selecting Packets for Mirroring">
2304 To be selected for mirroring, a given packet must enter or leave the
2305 bridge through a selected port and it must also be in one of the
2309 <column name="select_all">
2310 If true, every packet arriving or departing on any port is
2311 selected for mirroring.
2314 <column name="select_dst_port">
2315 Ports on which departing packets are selected for mirroring.
2318 <column name="select_src_port">
2319 Ports on which arriving packets are selected for mirroring.
2322 <column name="select_vlan">
2323 VLANs on which packets are selected for mirroring. An empty set
2324 selects packets on all VLANs.
2328 <group title="Mirroring Destination Configuration">
2330 These columns are mutually exclusive. Exactly one of them must be
2334 <column name="output_port">
2335 <p>Output port for selected packets, if nonempty.</p>
2336 <p>Specifying a port for mirror output reserves that port exclusively
2337 for mirroring. No frames other than those selected for mirroring
2339 will be forwarded to the port, and any frames received on the port
2340 will be discarded.</p>
2342 The output port may be any kind of port supported by Open vSwitch.
2343 It may be, for example, a physical port (sometimes called SPAN) or a
2348 <column name="output_vlan">
2349 <p>Output VLAN for selected packets, if nonempty.</p>
2350 <p>The frames will be sent out all ports that trunk
2351 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2352 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2353 trunk port, the frame's VLAN tag will be set to
2354 <ref column="output_vlan"/>, replacing any existing tag; when it is
2355 sent out an implicit VLAN port, the frame will not be tagged. This
2356 type of mirroring is sometimes called RSPAN.</p>
2358 See the documentation for
2359 <ref column="other_config" key="forward-bpdu"/> in the
2360 <ref table="Interface"/> table for a list of destination MAC
2361 addresses which will not be mirrored to a VLAN to avoid confusing
2362 switches that interpret the protocols that they represent.
2364 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2365 contains unmanaged switches. Consider an unmanaged physical switch
2366 with two ports: port 1, connected to an end host, and port 2,
2367 connected to an Open vSwitch configured to mirror received packets
2368 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2369 port 1 that the physical switch forwards to port 2. The Open vSwitch
2370 forwards this packet to its destination and then reflects it back on
2371 port 2 in VLAN 123. This reflected packet causes the unmanaged
2372 physical switch to replace the MAC learning table entry, which
2373 correctly pointed to port 1, with one that incorrectly points to port
2374 2. Afterward, the physical switch will direct packets destined for
2375 the end host to the Open vSwitch on port 2, instead of to the end
2376 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2377 desired in this scenario, then the physical switch must be replaced
2378 by one that learns Ethernet addresses on a per-VLAN basis. In
2379 addition, learning should be disabled on the VLAN containing mirrored
2380 traffic. If this is not done then intermediate switches will learn
2381 the MAC address of each end host from the mirrored traffic. If
2382 packets being sent to that end host are also mirrored, then they will
2383 be dropped since the switch will attempt to send them out the input
2384 port. Disabling learning for the VLAN will cause the switch to
2385 correctly send the packet out all ports configured for that VLAN. If
2386 Open vSwitch is being used as an intermediate switch, learning can be
2387 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2388 in the appropriate <ref table="Bridge"/> table or tables.</p>
2390 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2391 VLAN and should generally be preferred.
2396 <group title="Statistics: Mirror counters">
2398 Key-value pairs that report mirror statistics.
2400 <column name="statistics" key="tx_packets">
2401 Number of packets transmitted through this mirror.
2403 <column name="statistics" key="tx_bytes">
2404 Number of bytes transmitted through this mirror.
2408 <group title="Common Columns">
2409 The overall purpose of these columns is described under <code>Common
2410 Columns</code> at the beginning of this document.
2412 <column name="external_ids"/>
2416 <table name="Controller" title="OpenFlow controller configuration.">
2417 <p>An OpenFlow controller.</p>
2420 Open vSwitch supports two kinds of OpenFlow controllers:
2424 <dt>Primary controllers</dt>
2427 This is the kind of controller envisioned by the OpenFlow 1.0
2428 specification. Usually, a primary controller implements a network
2429 policy by taking charge of the switch's flow table.
2433 Open vSwitch initiates and maintains persistent connections to
2434 primary controllers, retrying the connection each time it fails or
2435 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2436 <ref table="Bridge"/> table applies to primary controllers.
2440 Open vSwitch permits a bridge to have any number of primary
2441 controllers. When multiple controllers are configured, Open
2442 vSwitch connects to all of them simultaneously. Because
2443 OpenFlow 1.0 does not specify how multiple controllers
2444 coordinate in interacting with a single switch, more than
2445 one primary controller should be specified only if the
2446 controllers are themselves designed to coordinate with each
2447 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2448 vendor extension may be useful for this.)
2451 <dt>Service controllers</dt>
2454 These kinds of OpenFlow controller connections are intended for
2455 occasional support and maintenance use, e.g. with
2456 <code>ovs-ofctl</code>. Usually a service controller connects only
2457 briefly to inspect or modify some of a switch's state.
2461 Open vSwitch listens for incoming connections from service
2462 controllers. The service controllers initiate and, if necessary,
2463 maintain the connections from their end. The <ref table="Bridge"
2464 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2465 not apply to service controllers.
2469 Open vSwitch supports configuring any number of service controllers.
2475 The <ref column="target"/> determines the type of controller.
2478 <group title="Core Features">
2479 <column name="target">
2480 <p>Connection method for controller.</p>
2482 The following connection methods are currently supported for primary
2486 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2488 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2489 the given <var>ip</var>, which must be expressed as an IP address
2490 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2491 column in the <ref table="Open_vSwitch"/> table must point to a
2492 valid SSL configuration when this form is used.</p>
2493 <p>SSL support is an optional feature that is not always built as
2494 part of Open vSwitch.</p>
2496 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2497 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2498 the given <var>ip</var>, which must be expressed as an IP address
2499 (not a DNS name).</dd>
2502 The following connection methods are currently supported for service
2506 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2509 Listens for SSL connections on the specified TCP <var>port</var>
2510 (default: 6633). If <var>ip</var>, which must be expressed as an
2511 IP address (not a DNS name), is specified, then connections are
2512 restricted to the specified local IP address.
2515 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2516 table="Open_vSwitch"/> table must point to a valid SSL
2517 configuration when this form is used.
2519 <p>SSL support is an optional feature that is not always built as
2520 part of Open vSwitch.</p>
2522 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2524 Listens for connections on the specified TCP <var>port</var>
2525 (default: 6633). If <var>ip</var>, which must be expressed as an
2526 IP address (not a DNS name), is specified, then connections are
2527 restricted to the specified local IP address.
2530 <p>When multiple controllers are configured for a single bridge, the
2531 <ref column="target"/> values must be unique. Duplicate
2532 <ref column="target"/> values yield unspecified results.</p>
2535 <column name="connection_mode">
2536 <p>If it is specified, this setting must be one of the following
2537 strings that describes how Open vSwitch contacts this OpenFlow
2538 controller over the network:</p>
2541 <dt><code>in-band</code></dt>
2542 <dd>In this mode, this controller's OpenFlow traffic travels over the
2543 bridge associated with the controller. With this setting, Open
2544 vSwitch allows traffic to and from the controller regardless of the
2545 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2546 would never be able to connect to the controller, because it did
2547 not have a flow to enable it.) This is the most common connection
2548 mode because it is not necessary to maintain two independent
2550 <dt><code>out-of-band</code></dt>
2551 <dd>In this mode, OpenFlow traffic uses a control network separate
2552 from the bridge associated with this controller, that is, the
2553 bridge does not use any of its own network devices to communicate
2554 with the controller. The control network must be configured
2555 separately, before or after <code>ovs-vswitchd</code> is started.
2559 <p>If not specified, the default is implementation-specific.</p>
2563 <group title="Controller Failure Detection and Handling">
2564 <column name="max_backoff">
2565 Maximum number of milliseconds to wait between connection attempts.
2566 Default is implementation-specific.
2569 <column name="inactivity_probe">
2570 Maximum number of milliseconds of idle time on connection to
2571 controller before sending an inactivity probe message. If Open
2572 vSwitch does not communicate with the controller for the specified
2573 number of seconds, it will send a probe. If a response is not
2574 received for the same additional amount of time, Open vSwitch
2575 assumes the connection has been broken and attempts to reconnect.
2576 Default is implementation-specific. A value of 0 disables
2581 <group title="Asynchronous Message Configuration">
2583 OpenFlow switches send certain messages to controllers spontanenously,
2584 that is, not in response to any request from the controller. These
2585 messages are called ``asynchronous messages.'' These columns allow
2586 asynchronous messages to be limited or disabled to ensure the best use
2587 of network resources.
2590 <column name="enable_async_messages">
2591 The OpenFlow protocol enables asynchronous messages at time of
2592 connection establishment, which means that a controller can receive
2593 asynchronous messages, potentially many of them, even if it turns them
2594 off immediately after connecting. Set this column to
2595 <code>false</code> to change Open vSwitch behavior to disable, by
2596 default, all asynchronous messages. The controller can use the
2597 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2598 on any messages that it does want to receive, if any.
2601 <column name="controller_rate_limit">
2603 The maximum rate at which the switch will forward packets to the
2604 OpenFlow controller, in packets per second. This feature prevents a
2605 single bridge from overwhelming the controller. If not specified,
2606 the default is implementation-specific.
2610 In addition, when a high rate triggers rate-limiting, Open vSwitch
2611 queues controller packets for each port and transmits them to the
2612 controller at the configured rate. The <ref
2613 column="controller_burst_limit"/> value limits the number of queued
2614 packets. Ports on a bridge share the packet queue fairly.
2618 Open vSwitch maintains two such packet rate-limiters per bridge: one
2619 for packets sent up to the controller because they do not correspond
2620 to any flow, and the other for packets sent up to the controller by
2621 request through flow actions. When both rate-limiters are filled with
2622 packets, the actual rate that packets are sent to the controller is
2623 up to twice the specified rate.
2627 <column name="controller_burst_limit">
2628 In conjunction with <ref column="controller_rate_limit"/>,
2629 the maximum number of unused packet credits that the bridge will
2630 allow to accumulate, in packets. If not specified, the default
2631 is implementation-specific.
2635 <group title="Additional In-Band Configuration">
2636 <p>These values are considered only in in-band control mode (see
2637 <ref column="connection_mode"/>).</p>
2639 <p>When multiple controllers are configured on a single bridge, there
2640 should be only one set of unique values in these columns. If different
2641 values are set for these columns in different controllers, the effect
2644 <column name="local_ip">
2645 The IP address to configure on the local port,
2646 e.g. <code>192.168.0.123</code>. If this value is unset, then
2647 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2651 <column name="local_netmask">
2652 The IP netmask to configure on the local port,
2653 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2654 but this value is unset, then the default is chosen based on whether
2655 the IP address is class A, B, or C.
2658 <column name="local_gateway">
2659 The IP address of the gateway to configure on the local port, as a
2660 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2661 this network has no gateway.
2665 <group title="Controller Status">
2666 <column name="is_connected">
2667 <code>true</code> if currently connected to this controller,
2668 <code>false</code> otherwise.
2672 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2673 <p>The level of authority this controller has on the associated
2674 bridge. Possible values are:</p>
2676 <dt><code>other</code></dt>
2677 <dd>Allows the controller access to all OpenFlow features.</dd>
2678 <dt><code>master</code></dt>
2679 <dd>Equivalent to <code>other</code>, except that there may be at
2680 most one master controller at a time. When a controller configures
2681 itself as <code>master</code>, any existing master is demoted to
2682 the <code>slave</code>role.</dd>
2683 <dt><code>slave</code></dt>
2684 <dd>Allows the controller read-only access to OpenFlow features.
2685 Attempts to modify the flow table will be rejected with an
2686 error. Slave controllers do not receive OFPT_PACKET_IN or
2687 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2692 <column name="status" key="last_error">
2693 A human-readable description of the last error on the connection
2694 to the controller; i.e. <code>strerror(errno)</code>. This key
2695 will exist only if an error has occurred.
2698 <column name="status" key="state"
2699 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2701 The state of the connection to the controller:
2704 <dt><code>VOID</code></dt>
2705 <dd>Connection is disabled.</dd>
2707 <dt><code>BACKOFF</code></dt>
2708 <dd>Attempting to reconnect at an increasing period.</dd>
2710 <dt><code>CONNECTING</code></dt>
2711 <dd>Attempting to connect.</dd>
2713 <dt><code>ACTIVE</code></dt>
2714 <dd>Connected, remote host responsive.</dd>
2716 <dt><code>IDLE</code></dt>
2717 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2720 These values may change in the future. They are provided only for
2725 <column name="status" key="sec_since_connect"
2726 type='{"type": "integer", "minInteger": 0}'>
2727 The amount of time since this controller last successfully connected to
2728 the switch (in seconds). Value is empty if controller has never
2729 successfully connected.
2732 <column name="status" key="sec_since_disconnect"
2733 type='{"type": "integer", "minInteger": 1}'>
2734 The amount of time since this controller last disconnected from
2735 the switch (in seconds). Value is empty if controller has never
2740 <group title="Connection Parameters">
2742 Additional configuration for a connection between the controller
2743 and the Open vSwitch.
2746 <column name="other_config" key="dscp"
2747 type='{"type": "integer"}'>
2748 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2749 in the Type of Service (TOS) field in the IP header. DSCP provides a
2750 mechanism to classify the network traffic and provide Quality of
2751 Service (QoS) on IP networks.
2753 The DSCP value specified here is used when establishing the connection
2754 between the controller and the Open vSwitch. If no value is specified,
2755 a default value of 48 is chosen. Valid DSCP values must be in the
2761 <group title="Common Columns">
2762 The overall purpose of these columns is described under <code>Common
2763 Columns</code> at the beginning of this document.
2765 <column name="external_ids"/>
2766 <column name="other_config"/>
2770 <table name="Manager" title="OVSDB management connection.">
2772 Configuration for a database connection to an Open vSwitch database
2777 This table primarily configures the Open vSwitch database
2778 (<code>ovsdb-server</code>), not the Open vSwitch switch
2779 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2780 what connections should be treated as in-band.
2784 The Open vSwitch database server can initiate and maintain active
2785 connections to remote clients. It can also listen for database
2789 <group title="Core Features">
2790 <column name="target">
2791 <p>Connection method for managers.</p>
2793 The following connection methods are currently supported:
2796 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2799 The specified SSL <var>port</var> (default: 6632) on the host at
2800 the given <var>ip</var>, which must be expressed as an IP address
2801 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2802 column in the <ref table="Open_vSwitch"/> table must point to a
2803 valid SSL configuration when this form is used.
2806 SSL support is an optional feature that is not always built as
2807 part of Open vSwitch.
2811 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2813 The specified TCP <var>port</var> (default: 6632) on the host at
2814 the given <var>ip</var>, which must be expressed as an IP address
2817 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2820 Listens for SSL connections on the specified TCP <var>port</var>
2821 (default: 6632). If <var>ip</var>, which must be expressed as an
2822 IP address (not a DNS name), is specified, then connections are
2823 restricted to the specified local IP address.
2826 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2827 table="Open_vSwitch"/> table must point to a valid SSL
2828 configuration when this form is used.
2831 SSL support is an optional feature that is not always built as
2832 part of Open vSwitch.
2835 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2837 Listens for connections on the specified TCP <var>port</var>
2838 (default: 6632). If <var>ip</var>, which must be expressed as an
2839 IP address (not a DNS name), is specified, then connections are
2840 restricted to the specified local IP address.
2843 <p>When multiple managers are configured, the <ref column="target"/>
2844 values must be unique. Duplicate <ref column="target"/> values yield
2845 unspecified results.</p>
2848 <column name="connection_mode">
2850 If it is specified, this setting must be one of the following strings
2851 that describes how Open vSwitch contacts this OVSDB client over the
2856 <dt><code>in-band</code></dt>
2858 In this mode, this connection's traffic travels over a bridge
2859 managed by Open vSwitch. With this setting, Open vSwitch allows
2860 traffic to and from the client regardless of the contents of the
2861 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2862 to connect to the client, because it did not have a flow to enable
2863 it.) This is the most common connection mode because it is not
2864 necessary to maintain two independent networks.
2866 <dt><code>out-of-band</code></dt>
2868 In this mode, the client's traffic uses a control network separate
2869 from that managed by Open vSwitch, that is, Open vSwitch does not
2870 use any of its own network devices to communicate with the client.
2871 The control network must be configured separately, before or after
2872 <code>ovs-vswitchd</code> is started.
2877 If not specified, the default is implementation-specific.
2882 <group title="Client Failure Detection and Handling">
2883 <column name="max_backoff">
2884 Maximum number of milliseconds to wait between connection attempts.
2885 Default is implementation-specific.
2888 <column name="inactivity_probe">
2889 Maximum number of milliseconds of idle time on connection to the client
2890 before sending an inactivity probe message. If Open vSwitch does not
2891 communicate with the client for the specified number of seconds, it
2892 will send a probe. If a response is not received for the same
2893 additional amount of time, Open vSwitch assumes the connection has been
2894 broken and attempts to reconnect. Default is implementation-specific.
2895 A value of 0 disables inactivity probes.
2899 <group title="Status">
2900 <column name="is_connected">
2901 <code>true</code> if currently connected to this manager,
2902 <code>false</code> otherwise.
2905 <column name="status" key="last_error">
2906 A human-readable description of the last error on the connection
2907 to the manager; i.e. <code>strerror(errno)</code>. This key
2908 will exist only if an error has occurred.
2911 <column name="status" key="state"
2912 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2914 The state of the connection to the manager:
2917 <dt><code>VOID</code></dt>
2918 <dd>Connection is disabled.</dd>
2920 <dt><code>BACKOFF</code></dt>
2921 <dd>Attempting to reconnect at an increasing period.</dd>
2923 <dt><code>CONNECTING</code></dt>
2924 <dd>Attempting to connect.</dd>
2926 <dt><code>ACTIVE</code></dt>
2927 <dd>Connected, remote host responsive.</dd>
2929 <dt><code>IDLE</code></dt>
2930 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2933 These values may change in the future. They are provided only for
2938 <column name="status" key="sec_since_connect"
2939 type='{"type": "integer", "minInteger": 0}'>
2940 The amount of time since this manager last successfully connected
2941 to the database (in seconds). Value is empty if manager has never
2942 successfully connected.
2945 <column name="status" key="sec_since_disconnect"
2946 type='{"type": "integer", "minInteger": 0}'>
2947 The amount of time since this manager last disconnected from the
2948 database (in seconds). Value is empty if manager has never
2952 <column name="status" key="locks_held">
2953 Space-separated list of the names of OVSDB locks that the connection
2954 holds. Omitted if the connection does not hold any locks.
2957 <column name="status" key="locks_waiting">
2958 Space-separated list of the names of OVSDB locks that the connection is
2959 currently waiting to acquire. Omitted if the connection is not waiting
2963 <column name="status" key="locks_lost">
2964 Space-separated list of the names of OVSDB locks that the connection
2965 has had stolen by another OVSDB client. Omitted if no locks have been
2966 stolen from this connection.
2969 <column name="status" key="n_connections"
2970 type='{"type": "integer", "minInteger": 2}'>
2972 When <ref column="target"/> specifies a connection method that
2973 listens for inbound connections (e.g. <code>ptcp:</code> or
2974 <code>pssl:</code>) and more than one connection is actually active,
2975 the value is the number of active connections. Otherwise, this
2976 key-value pair is omitted.
2979 When multiple connections are active, status columns and key-value
2980 pairs (other than this one) report the status of one arbitrarily
2986 <group title="Connection Parameters">
2988 Additional configuration for a connection between the manager
2989 and the Open vSwitch Database.
2992 <column name="other_config" key="dscp"
2993 type='{"type": "integer"}'>
2994 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2995 in the Type of Service (TOS) field in the IP header. DSCP provides a
2996 mechanism to classify the network traffic and provide Quality of
2997 Service (QoS) on IP networks.
2999 The DSCP value specified here is used when establishing the connection
3000 between the manager and the Open vSwitch. If no value is specified, a
3001 default value of 48 is chosen. Valid DSCP values must be in the range
3006 <group title="Common Columns">
3007 The overall purpose of these columns is described under <code>Common
3008 Columns</code> at the beginning of this document.
3010 <column name="external_ids"/>
3011 <column name="other_config"/>
3015 <table name="NetFlow">
3016 A NetFlow target. NetFlow is a protocol that exports a number of
3017 details about terminating IP flows, such as the principals involved
3020 <column name="targets">
3021 NetFlow targets in the form
3022 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3023 must be specified numerically, not as a DNS name.
3026 <column name="engine_id">
3027 Engine ID to use in NetFlow messages. Defaults to datapath index
3031 <column name="engine_type">
3032 Engine type to use in NetFlow messages. Defaults to datapath
3033 index if not specified.
3036 <column name="active_timeout">
3037 The interval at which NetFlow records are sent for flows that are
3038 still active, in seconds. A value of <code>0</code> requests the
3039 default timeout (currently 600 seconds); a value of <code>-1</code>
3040 disables active timeouts.
3043 <column name="add_id_to_interface">
3044 <p>If this column's value is <code>false</code>, the ingress and egress
3045 interface fields of NetFlow flow records are derived from OpenFlow port
3046 numbers. When it is <code>true</code>, the 7 most significant bits of
3047 these fields will be replaced by the least significant 7 bits of the
3048 engine id. This is useful because many NetFlow collectors do not
3049 expect multiple switches to be sending messages from the same host, so
3050 they do not store the engine information which could be used to
3051 disambiguate the traffic.</p>
3052 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3055 <group title="Common Columns">
3056 The overall purpose of these columns is described under <code>Common
3057 Columns</code> at the beginning of this document.
3059 <column name="external_ids"/>
3064 SSL configuration for an Open_vSwitch.
3066 <column name="private_key">
3067 Name of a PEM file containing the private key used as the switch's
3068 identity for SSL connections to the controller.
3071 <column name="certificate">
3072 Name of a PEM file containing a certificate, signed by the
3073 certificate authority (CA) used by the controller and manager,
3074 that certifies the switch's private key, identifying a trustworthy
3078 <column name="ca_cert">
3079 Name of a PEM file containing the CA certificate used to verify
3080 that the switch is connected to a trustworthy controller.
3083 <column name="bootstrap_ca_cert">
3084 If set to <code>true</code>, then Open vSwitch will attempt to
3085 obtain the CA certificate from the controller on its first SSL
3086 connection and save it to the named PEM file. If it is successful,
3087 it will immediately drop the connection and reconnect, and from then
3088 on all SSL connections must be authenticated by a certificate signed
3089 by the CA certificate thus obtained. <em>This option exposes the
3090 SSL connection to a man-in-the-middle attack obtaining the initial
3091 CA certificate.</em> It may still be useful for bootstrapping.
3094 <group title="Common Columns">
3095 The overall purpose of these columns is described under <code>Common
3096 Columns</code> at the beginning of this document.
3098 <column name="external_ids"/>
3102 <table name="sFlow">
3103 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3106 <column name="agent">
3107 Name of the network device whose IP address should be reported as the
3108 ``agent address'' to collectors. If not specified, the agent device is
3109 figured from the first target address and the routing table. If the
3110 routing table does not contain a route to the target, the IP address
3111 defaults to the <ref table="Controller" column="local_ip"/> in the
3112 collector's <ref table="Controller"/>. If an agent IP address cannot be
3113 determined any of these ways, sFlow is disabled.
3116 <column name="header">
3117 Number of bytes of a sampled packet to send to the collector.
3118 If not specified, the default is 128 bytes.
3121 <column name="polling">
3122 Polling rate in seconds to send port statistics to the collector.
3123 If not specified, defaults to 30 seconds.
3126 <column name="sampling">
3127 Rate at which packets should be sampled and sent to the collector.
3128 If not specified, defaults to 400, which means one out of 400
3129 packets, on average, will be sent to the collector.
3132 <column name="targets">
3133 sFlow targets in the form
3134 <code><var>ip</var>:<var>port</var></code>.
3137 <group title="Common Columns">
3138 The overall purpose of these columns is described under <code>Common
3139 Columns</code> at the beginning of this document.
3141 <column name="external_ids"/>