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 <column name="capabilities">
91 Describes functionality supported by the hardware and software platform
92 on which this Open vSwitch is based. Clients should not modify this
93 column. See the <ref table="Capability"/> description for defined
94 capability categories and the meaning of associated
95 <ref table="Capability"/> records.
98 <group title="Statistics">
100 The <code>statistics</code> column contains key-value pairs that
101 report statistics about a system running an Open vSwitch. These are
102 updated periodically (currently, every 5 seconds). Key-value pairs
103 that cannot be determined or that do not apply to a platform are
107 <column name="other_config" key="enable-statistics"
108 type='{"type": "boolean"}'>
109 Statistics are disabled by default to avoid overhead in the common
110 case when statistics gathering is not useful. Set this value to
111 <code>true</code> to enable populating the <ref column="statistics"/>
112 column or to <code>false</code> to explicitly disable it.
115 <column name="statistics" key="cpu"
116 type='{"type": "integer", "minInteger": 1}'>
118 Number of CPU processors, threads, or cores currently online and
119 available to the operating system on which Open vSwitch is running,
120 as an integer. This may be less than the number installed, if some
121 are not online or if they are not available to the operating
125 Open vSwitch userspace processes are not multithreaded, but the
126 Linux kernel-based datapath is.
130 <column name="statistics" key="load_average">
131 A comma-separated list of three floating-point numbers,
132 representing the system load average over the last 1, 5, and 15
133 minutes, respectively.
136 <column name="statistics" key="memory">
138 A comma-separated list of integers, each of which represents a
139 quantity of memory in kilobytes that describes the operating
140 system on which Open vSwitch is running. In respective order,
145 <li>Total amount of RAM allocated to the OS.</li>
146 <li>RAM allocated to the OS that is in use.</li>
147 <li>RAM that can be flushed out to disk or otherwise discarded
148 if that space is needed for another purpose. This number is
149 necessarily less than or equal to the previous value.</li>
150 <li>Total disk space allocated for swap.</li>
151 <li>Swap space currently in use.</li>
155 On Linux, all five values can be determined and are included. On
156 other operating systems, only the first two values can be
157 determined, so the list will only have two values.
161 <column name="statistics" key="process_NAME">
163 One such key-value pair, with <code>NAME</code> replaced by
164 a process name, will exist for each running Open vSwitch
165 daemon process, with <var>name</var> replaced by the
166 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
167 value is a comma-separated list of integers. The integers
168 represent the following, with memory measured in kilobytes
169 and durations in milliseconds:
173 <li>The process's virtual memory size.</li>
174 <li>The process's resident set size.</li>
175 <li>The amount of user and system CPU time consumed by the
177 <li>The number of times that the process has crashed and been
178 automatically restarted by the monitor.</li>
179 <li>The duration since the process was started.</li>
180 <li>The duration for which the process has been running.</li>
184 The interpretation of some of these values depends on whether the
185 process was started with the <option>--monitor</option>. If it
186 was not, then the crash count will always be 0 and the two
187 durations will always be the same. If <option>--monitor</option>
188 was given, then the crash count may be positive; if it is, the
189 latter duration is the amount of time since the most recent crash
194 There will be one key-value pair for each file in Open vSwitch's
195 ``run directory'' (usually <code>/var/run/openvswitch</code>)
196 whose name ends in <code>.pid</code>, whose contents are a
197 process ID, and which is locked by a running process. The
198 <var>name</var> is taken from the pidfile's name.
202 Currently Open vSwitch is only able to obtain all of the above
203 detail on Linux systems. On other systems, the same key-value
204 pairs will be present but the values will always be the empty
209 <column name="statistics" key="file_systems">
211 A space-separated list of information on local, writable file
212 systems. Each item in the list describes one file system and
213 consists in turn of a comma-separated list of the following:
217 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
218 Any spaces or commas in the mount point are replaced by
220 <li>Total size, in kilobytes, as an integer.</li>
221 <li>Amount of storage in use, in kilobytes, as an integer.</li>
225 This key-value pair is omitted if there are no local, writable
226 file systems or if Open vSwitch cannot obtain the needed
233 <group title="Version Reporting">
235 These columns report the types and versions of the hardware and
236 software running Open vSwitch. We recommend in general that software
237 should test whether specific features are supported instead of relying
238 on version number checks. These values are primarily intended for
239 reporting to human administrators.
242 <column name="ovs_version">
243 The Open vSwitch version number, e.g. <code>1.1.0</code>.
244 If Open vSwitch was configured with a build number, then it is
245 also included, e.g. <code>1.1.0+build6579</code>.
248 <column name="db_version">
250 The database schema version number in the form
251 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
252 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
253 a non-backward compatible way (e.g. deleting a column or a table),
254 <var>major</var> is incremented. When the database schema is changed
255 in a backward compatible way (e.g. adding a new column),
256 <var>minor</var> is incremented. When the database schema is changed
257 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
262 The schema version is part of the database schema, so it can also be
263 retrieved by fetching the schema using the Open vSwitch database
268 <column name="system_type">
270 An identifier for the type of system on top of which Open vSwitch
271 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
274 System integrators are responsible for choosing and setting an
275 appropriate value for this column.
279 <column name="system_version">
281 The version of the system identified by <ref column="system_type"/>,
282 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
285 System integrators are responsible for choosing and setting an
286 appropriate value for this column.
292 <group title="Database Configuration">
294 These columns primarily configure the Open vSwitch database
295 (<code>ovsdb-server</code>), not the Open vSwitch switch
296 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
297 column="ssl"/> settings.
301 The Open vSwitch switch does read the database configuration to
302 determine remote IP addresses to which in-band control should apply.
305 <column name="manager_options">
306 Database clients to which the Open vSwitch database server should
307 connect or to which it should listen, along with options for how these
308 connection should be configured. See the <ref table="Manager"/> table
309 for more information.
313 <group title="Common Columns">
314 The overall purpose of these columns is described under <code>Common
315 Columns</code> at the beginning of this document.
317 <column name="other_config"/>
318 <column name="external_ids"/>
322 <table name="Bridge">
324 Configuration for a bridge within an
325 <ref table="Open_vSwitch"/>.
328 A <ref table="Bridge"/> record represents an Ethernet switch with one or
329 more ``ports,'' which are the <ref table="Port"/> records pointed to by
330 the <ref table="Bridge"/>'s <ref column="ports"/> column.
333 <group title="Core Features">
335 Bridge identifier. Should be alphanumeric and no more than about 8
336 bytes long. Must be unique among the names of ports, interfaces, and
340 <column name="ports">
341 Ports included in the bridge.
344 <column name="mirrors">
345 Port mirroring configuration.
348 <column name="netflow">
349 NetFlow configuration.
352 <column name="sflow">
356 <column name="flood_vlans">
358 VLAN IDs of VLANs on which MAC address learning should be disabled,
359 so that packets are flooded instead of being sent to specific ports
360 that are believed to contain packets' destination MACs. This should
361 ordinarily be used to disable MAC learning on VLANs used for
362 mirroring (RSPAN VLANs). It may also be useful for debugging.
365 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
366 the <ref table="Port"/> table) is incompatible with
367 <code>flood_vlans</code>. Consider using another bonding mode or
368 a different type of mirror instead.
373 <group title="OpenFlow Configuration">
374 <column name="controller">
375 OpenFlow controller set. If unset, then no OpenFlow controllers
379 <column name="fail_mode">
380 <p>When a controller is configured, it is, ordinarily, responsible
381 for setting up all flows on the switch. Thus, if the connection to
382 the controller fails, no new network connections can be set up.
383 If the connection to the controller stays down long enough,
384 no packets can pass through the switch at all. This setting
385 determines the switch's response to such a situation. It may be set
386 to one of the following:
388 <dt><code>standalone</code></dt>
389 <dd>If no message is received from the controller for three
390 times the inactivity probe interval
391 (see <ref column="inactivity_probe"/>), then Open vSwitch
392 will take over responsibility for setting up flows. In
393 this mode, Open vSwitch causes the bridge to act like an
394 ordinary MAC-learning switch. Open vSwitch will continue
395 to retry connecting to the controller in the background
396 and, when the connection succeeds, it will discontinue its
397 standalone behavior.</dd>
398 <dt><code>secure</code></dt>
399 <dd>Open vSwitch will not set up flows on its own when the
400 controller connection fails or when no controllers are
401 defined. The bridge will continue to retry connecting to
402 any defined controllers forever.</dd>
405 <p>If this value is unset, the default is implementation-specific.</p>
406 <p>When more than one controller is configured,
407 <ref column="fail_mode"/> is considered only when none of the
408 configured controllers can be contacted.</p>
411 <column name="datapath_id">
412 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
413 (Setting this column has no useful effect. Set <ref
414 column="other-config" key="datapath-id"/> instead.)
417 <column name="other_config" key="datapath-id">
418 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
419 value. May not be all-zero.
422 <column name="other_config" key="disable-in-band"
423 type='{"type": "boolean"}'>
424 If set to <code>true</code>, disable in-band control on the bridge
425 regardless of controller and manager settings.
428 <column name="other_config" key="in-band-queue"
429 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
430 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
431 that will be used by flows set up by in-band control on this bridge.
432 If unset, or if the port used by an in-band control flow does not have
433 QoS configured, or if the port does not have a queue with the specified
434 ID, the default queue is used instead.
438 <group title="Spanning Tree Configuration">
439 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
440 that ensures loop-free topologies. It allows redundant links to
441 be included in the network to provide automatic backup paths if
442 the active links fails.
444 <column name="stp_enable">
445 Enable spanning tree on the bridge. By default, STP is disabled
446 on bridges. Bond, internal, and mirror ports are not supported
447 and will not participate in the spanning tree.
450 <column name="other_config" key="stp-system-id">
451 The bridge's STP identifier (the lower 48 bits of the bridge-id)
453 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
454 By default, the identifier is the MAC address of the bridge.
457 <column name="other_config" key="stp-priority"
458 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
459 The bridge's relative priority value for determining the root
460 bridge (the upper 16 bits of the bridge-id). A bridge with the
461 lowest bridge-id is elected the root. By default, the priority
465 <column name="other_config" key="stp-hello-time"
466 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
467 The interval between transmissions of hello messages by
468 designated ports, in seconds. By default the hello interval is
472 <column name="other_config" key="stp-max-age"
473 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
474 The maximum age of the information transmitted by the bridge
475 when it is the root bridge, in seconds. By default, the maximum
479 <column name="other_config" key="stp-forward-delay"
480 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
481 The delay to wait between transitioning root and designated
482 ports to <code>forwarding</code>, in seconds. By default, the
483 forwarding delay is 15 seconds.
487 <group title="Other Features">
488 <column name="datapath_type">
489 Name of datapath provider. The kernel datapath has
490 type <code>system</code>. The userspace datapath has
491 type <code>netdev</code>.
494 <column name="external_ids" key="bridge-id">
495 A unique identifier of the bridge. On Citrix XenServer this will
496 commonly be the same as
497 <ref column="external_ids" key="xs-network-uuids"/>.
500 <column name="external_ids" key="xs-network-uuids">
501 Semicolon-delimited set of universally unique identifier(s) for the
502 network with which this bridge is associated on a Citrix XenServer
503 host. The network identifiers are RFC 4122 UUIDs as displayed by,
504 e.g., <code>xe network-list</code>.
507 <column name="other_config" key="hwaddr">
508 An Ethernet address in the form
509 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
510 to set the hardware address of the local port and influence the
514 <column name="other_config" key="flow-eviction-threshold"
515 type='{"type": "integer", "minInteger": 0}'>
517 A number of flows as a nonnegative integer. This sets number of
518 flows at which eviction from the kernel flow table will be triggered.
519 If there are a large number of flows then increasing this value to
520 around the number of flows present can result in reduced CPU usage
524 The default is 1000. Values below 100 will be rounded up to 100.
528 <column name="other_config" key="forward-bpdu"
529 type='{"type": "boolean"}'>
530 Option to allow forwarding of BPDU frames when NORMAL action is
531 invoked. Frames with reserved Ethernet addresses (e.g. STP
532 BPDU) will be forwarded when this option is enabled and the
533 switch is not providing that functionality. If STP is enabled
534 on the port, STP BPDUs will never be forwarded. If the Open
535 vSwitch bridge is used to connect different Ethernet networks,
536 and if Open vSwitch node does not run STP, then this option
537 should be enabled. Default is disabled, set to
538 <code>true</code> to enable.
542 <group title="Bridge Status">
544 Status information about bridges.
546 <column name="status">
547 Key-value pairs that report bridge status.
549 <column name="status" key="stp_bridge_id">
551 The bridge-id (in hex) used in spanning tree advertisements.
552 Configuring the bridge-id is described in the
553 <code>stp-system-id</code> and <code>stp-priority</code> keys
554 of the <code>other_config</code> section earlier.
557 <column name="status" key="stp_designated_root">
559 The designated root (in hex) for this spanning tree.
562 <column name="status" key="stp_root_path_cost">
564 The path cost of reaching the designated bridge. A lower
570 <group title="Common Columns">
571 The overall purpose of these columns is described under <code>Common
572 Columns</code> at the beginning of this document.
574 <column name="other_config"/>
575 <column name="external_ids"/>
579 <table name="Port" table="Port or bond configuration.">
580 <p>A port within a <ref table="Bridge"/>.</p>
581 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
582 <ref column="interfaces"/> column. Such a port logically
583 corresponds to a port on a physical Ethernet switch. A port
584 with more than one interface is a ``bonded port'' (see
585 <ref group="Bonding Configuration"/>).</p>
586 <p>Some properties that one might think as belonging to a port are actually
587 part of the port's <ref table="Interface"/> members.</p>
590 Port name. Should be alphanumeric and no more than about 8
591 bytes long. May be the same as the interface name, for
592 non-bonded ports. Must otherwise be unique among the names of
593 ports, interfaces, and bridges on a host.
596 <column name="interfaces">
597 The port's interfaces. If there is more than one, this is a
601 <group title="VLAN Configuration">
602 <p>Bridge ports support the following types of VLAN configuration:</p>
607 A trunk port carries packets on one or more specified VLANs
608 specified in the <ref column="trunks"/> column (often, on every
609 VLAN). A packet that ingresses on a trunk port is in the VLAN
610 specified in its 802.1Q header, or VLAN 0 if the packet has no
611 802.1Q header. A packet that egresses through a trunk port will
612 have a 802.1Q header if it has a nonzero VLAN ID (or a nonzero
617 Any packet that ingresses on a trunk port tagged with a VLAN that
618 the port does not trunk is dropped.
625 An access port carries packets on exactly one VLAN specified in the
626 <ref column="tag"/> column. Packets ingressing and egressing on an
627 access port have no 802.1Q header.
631 Any packet with an 802.1Q header that ingresses on an access port
632 is dropped, regardless of whether the VLAN ID in the header is the
633 access port's VLAN ID.
637 <dt>native-tagged</dt>
639 A native-tagged port resembles a trunk port, with the exception that
640 a packet without an 802.1Q header that ingresses on a native-tagged
641 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
645 <dt>native-untagged</dt>
647 A native-untagged port resembles a native-tagged port, with the
648 exception that a packet that egresses on a native-untagged port in
649 the native VLAN not have an 802.1Q header.
653 A packet will only egress through bridge ports that carry the VLAN of
654 the packet, as described by the rules above.
657 <column name="vlan_mode">
659 The VLAN mode of the port, as described above. When this column is
660 empty, a default mode is selected as follows:
664 If <ref column="tag"/> contains a value, the port is an access
665 port. The <ref column="trunks"/> column should be empty.
668 Otherwise, the port is a trunk port. The <ref column="trunks"/>
669 column value is honored if it is present.
676 For an access port, the port's implicitly tagged VLAN. For a
677 native-tagged or native-untagged port, the port's native VLAN. Must
678 be empty if this is a trunk port.
682 <column name="trunks">
684 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
685 or VLANs that this port trunks; if it is empty, then the port trunks
686 all VLANs. Must be empty if this is an access port.
689 A native-tagged or native-untagged port always trunks its native
690 VLAN, regardless of whether <ref column="trunks"/> includes that
696 <group title="Bonding Configuration">
697 <p>A port that has more than one interface is a ``bonded port.'' Bonding
698 allows for load balancing and fail-over. Some kinds of bonding will
699 work with any kind of upstream switch:</p>
702 <dt><code>balance-slb</code></dt>
704 Balances flows among slaves based on source MAC address and output
705 VLAN, with periodic rebalancing as traffic patterns change.
708 <dt><code>active-backup</code></dt>
710 Assigns all flows to one slave, failing over to a backup slave when
711 the active slave is disabled.
716 The following modes require the upstream switch to support 802.3ad with
717 successful LACP negotiation. If LACP negotiation fails then
718 <code>balance-slb</code> style flow hashing is used as a fallback:
722 <dt><code>balance-tcp</code></dt>
724 Balances flows among slaves based on L2, L3, and L4 protocol
725 information such as destination MAC address, IP address, and TCP
729 <dt><code>stable</code></dt>
731 <p>Attempts to always assign a given flow to the same slave
732 consistently. In an effort to maintain stability, no load
733 balancing is done. Uses a similar hashing strategy to
734 <code>balance-tcp</code>, always taking into account L3 and L4
735 fields even if LACP negotiations are unsuccessful. </p>
736 <p>Slave selection decisions are made based on <ref table="Interface"
737 column="other_config" key="bond-stable-id"/> if set. Otherwise,
738 OpenFlow port number is used. Decisions are consistent across all
739 <code>ovs-vswitchd</code> instances with equivalent
740 <ref table="Interface" column="other_config" key="bond-stable-id"/>
745 <p>These columns apply only to bonded ports. Their values are
746 otherwise ignored.</p>
748 <column name="bond_mode">
749 <p>The type of bonding used for a bonded port. Defaults to
750 <code>balance-slb</code> if unset.
754 <group title="Link Failure Detection">
756 An important part of link bonding is detecting that links are down so
757 that they may be disabled. These settings determine how Open vSwitch
758 detects link failure.
761 <column name="other_config" key="bond-detect-mode"
762 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
763 The means used to detect link failures. Defaults to
764 <code>carrier</code> which uses each interface's carrier to detect
765 failures. When set to <code>miimon</code>, will check for failures
766 by polling each interface's MII.
769 <column name="other_config" key="bond-miimon-interval"
770 type='{"type": "integer"}'>
771 The interval, in milliseconds, between successive attempts to poll
772 each interface's MII. Relevant only when <ref column="other_config"
773 key="bond-detect-mode"/> is <code>miimon</code>.
776 <column name="bond_updelay">
778 The number of milliseconds for which carrier must stay up on an
779 interface before the interface is considered to be up. Specify
780 <code>0</code> to enable the interface immediately.
784 This setting is honored only when at least one bonded interface is
785 already enabled. When no interfaces are enabled, then the first
786 bond interface to come up is enabled immediately.
790 <column name="bond_downdelay">
791 The number of milliseconds for which carrier must stay down on an
792 interface before the interface is considered to be down. Specify
793 <code>0</code> to disable the interface immediately.
797 <group title="LACP Configuration">
799 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
800 allows switches to automatically detect that they are connected by
801 multiple links and aggregate across those links. These settings
802 control LACP behavior.
806 Configures LACP on this port. LACP allows directly connected
807 switches to negotiate which links may be bonded. LACP may be enabled
808 on non-bonded ports for the benefit of any switches they may be
809 connected to. <code>active</code> ports are allowed to initiate LACP
810 negotiations. <code>passive</code> ports are allowed to participate
811 in LACP negotiations initiated by a remote switch, but not allowed to
812 initiate such negotiations themselves. Defaults to <code>off</code>
816 <column name="other_config" key="lacp-system-id">
817 The LACP system ID of this <ref table="Port"/>. The system ID of a
818 LACP bond is used to identify itself to its partners. Must be a
822 <column name="other_config" key="lacp-system-priority"
823 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
824 The LACP system priority of this <ref table="Port"/>. In LACP
825 negotiations, link status decisions are made by the system with the
826 numerically lower priority.
829 <column name="other_config" key="lacp-time">
831 The LACP timing which should be used on this <ref table="Port"/>.
832 Possible values are <code>fast</code>, <code>slow</code> and a
833 positive number of milliseconds. By default <code>slow</code> is
834 used. When configured to be <code>fast</code> LACP heartbeats are
835 requested at a rate of once per second causing connectivity
836 problems to be detected more quickly. In <code>slow</code> mode,
837 heartbeats are requested at a rate of once every 30 seconds.
841 Users may manually set a heartbeat transmission rate to increase
842 the fault detection speed further. When manually set, OVS expects
843 the partner switch to be configured with the same transmission
844 rate. Manually setting <code>lacp-time</code> to something other
845 than <code>fast</code> or <code>slow</code> is not supported by the
850 <column name="other_config" key="lacp-heartbeat"
851 type='{"type": "boolean"}'>
852 Treat LACP like a simple heartbeat protocol for link state
853 monitoring. Most features of the LACP protocol are disabled
854 when this mode is in use. The default if not specified is
858 <column name="other_config" key="bond-hash-basis"
859 type='{"type": "integer"}'>
860 An integer hashed along with flows when choosing output slaves. When
861 changed, all flows will be assigned different hash values possibly
862 causing slave selection decisions to change.
866 <group title="SLB Configuration">
868 These settings control behavior when a bond is in
869 <code>balance-slb</code> mode, regardless of whether the bond was
870 intentionally configured in SLB mode or it fell back to SLB mode
871 because LACP negotiation failed.
874 <column name="other_config" key="bond-rebalance-interval"
875 type='{"type": "integer", "minInteger": 1000, "maxInteger": 10000}'>
876 For an SLB bonded port, the number of milliseconds between successive
877 attempts to rebalance the bond, that is, to move source MACs and
878 their flows from one interface on the bond to another in an attempt
879 to keep usage of each interface roughly equal.
883 <column name="bond_fake_iface">
884 For a bonded port, whether to create a fake internal interface with the
885 name of the port. Use only for compatibility with legacy software that
890 <group title="Spanning Tree Configuration">
891 <column name="other_config" key="stp-enable"
892 type='{"type": "boolean"}'>
893 If spanning tree is enabled on the bridge, member ports are
894 enabled by default (with the exception of bond, internal, and
895 mirror ports which do not work with STP). If this column's
896 value is <code>false</code> spanning tree is disabled on the
900 <column name="other_config" key="stp-port-num"
901 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
902 The port number used for the lower 8 bits of the port-id. By
903 default, the numbers will be assigned automatically. If any
904 port's number is manually configured on a bridge, then they
908 <column name="other_config" key="stp-port-priority"
909 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
910 The port's relative priority value for determining the root
911 port (the upper 8 bits of the port-id). A port with a lower
912 port-id will be chosen as the root port. By default, the
916 <column name="other_config" key="stp-path-cost"
917 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
918 Spanning tree path cost for the port. A lower number indicates
919 a faster link. By default, the cost is based on the maximum
924 <group title="Other Features">
926 Quality of Service configuration for this port.
930 The MAC address to use for this port for the purpose of choosing the
931 bridge's MAC address. This column does not necessarily reflect the
932 port's actual MAC address, nor will setting it change the port's actual
936 <column name="fake_bridge">
937 Does this port represent a sub-bridge for its tagged VLAN within the
938 Bridge? See ovs-vsctl(8) for more information.
941 <column name="external_ids" key="fake-bridge-id-*">
942 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
943 column) are defined by prefixing a <ref table="Bridge"/> <ref
944 table="Bridge" column="external_ids"/> key with
945 <code>fake-bridge-</code>,
946 e.g. <code>fake-bridge-xs-network-uuids</code>.
950 <group title="Port Status">
952 Status information about ports attached to bridges.
954 <column name="status">
955 Key-value pairs that report port status.
957 <column name="status" key="stp_port_id">
959 The port-id (in hex) used in spanning tree advertisements for
960 this port. Configuring the port-id is described in the
961 <code>stp-port-num</code> and <code>stp-port-priority</code>
962 keys of the <code>other_config</code> section earlier.
965 <column name="status" key="stp_state"
966 type='{"type": "string", "enum": ["set",
967 ["disabled", "listening", "learning",
968 "forwarding", "blocking"]]}'>
970 STP state of the port.
973 <column name="status" key="stp_sec_in_state"
974 type='{"type": "integer", "minInteger": 0}'>
976 The amount of time (in seconds) port has been in the current
980 <column name="status" key="stp_role"
981 type='{"type": "string", "enum": ["set",
982 ["root", "designated", "alternate"]]}'>
984 STP role of the port.
989 <group title="Common Columns">
990 The overall purpose of these columns is described under <code>Common
991 Columns</code> at the beginning of this document.
993 <column name="other_config"/>
994 <column name="external_ids"/>
998 <table name="Interface" title="One physical network device in a Port.">
999 An interface within a <ref table="Port"/>.
1001 <group title="Core Features">
1002 <column name="name">
1003 Interface name. Should be alphanumeric and no more than about 8 bytes
1004 long. May be the same as the port name, for non-bonded ports. Must
1005 otherwise be unique among the names of ports, interfaces, and bridges
1010 <p>Ethernet address to set for this interface. If unset then the
1011 default MAC address is used:</p>
1013 <li>For the local interface, the default is the lowest-numbered MAC
1014 address among the other bridge ports, either the value of the
1015 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1016 if set, or its actual MAC (for bonded ports, the MAC of its slave
1017 whose name is first in alphabetical order). Internal ports and
1018 bridge ports that are used as port mirroring destinations (see the
1019 <ref table="Mirror"/> table) are ignored.</li>
1020 <li>For other internal interfaces, the default MAC is randomly
1022 <li>External interfaces typically have a MAC address associated with
1023 their hardware.</li>
1025 <p>Some interfaces may not have a software-controllable MAC
1029 <column name="ofport">
1030 <p>OpenFlow port number for this interface. Unlike most columns, this
1031 column's value should be set only by Open vSwitch itself. Other
1032 clients should set this column to an empty set (the default) when
1033 creating an <ref table="Interface"/>.</p>
1034 <p>Open vSwitch populates this column when the port number becomes
1035 known. If the interface is successfully added,
1036 <ref column="ofport"/> will be set to a number between 1 and 65535
1037 (generally either in the range 1 to 65279, inclusive, or 65534, the
1038 port number for the OpenFlow ``local port''). If the interface
1039 cannot be added then Open vSwitch sets this column
1044 <group title="System-Specific Details">
1045 <column name="type">
1047 The interface type, one of:
1051 <dt><code>system</code></dt>
1052 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1053 Sometimes referred to as ``external interfaces'' since they are
1054 generally connected to hardware external to that on which the Open
1055 vSwitch is running. The empty string is a synonym for
1056 <code>system</code>.</dd>
1058 <dt><code>internal</code></dt>
1059 <dd>A simulated network device that sends and receives traffic. An
1060 internal interface whose <ref column="name"/> is the same as its
1061 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1062 ``local interface.'' It does not make sense to bond an internal
1063 interface, so the terms ``port'' and ``interface'' are often used
1064 imprecisely for internal interfaces.</dd>
1066 <dt><code>tap</code></dt>
1067 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1069 <dt><code>gre</code></dt>
1071 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1072 tunnel. See <ref group="Tunnel Options"/> for information on
1073 configuring GRE tunnels.
1076 <dt><code>ipsec_gre</code></dt>
1078 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1082 <dt><code>capwap</code></dt>
1084 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1085 5415). This allows interoperability with certain switches that do
1086 not support GRE. Only the tunneling component of the protocol is
1087 implemented. UDP ports 58881 and 58882 are used as the source and
1088 destination ports respectively. CAPWAP is currently supported only
1089 with the Linux kernel datapath with kernel version 2.6.26 or later.
1092 <dt><code>patch</code></dt>
1094 A pair of virtual devices that act as a patch cable.
1097 <dt><code>null</code></dt>
1098 <dd>An ignored interface.</dd>
1103 <group title="Tunnel Options">
1105 These options apply to interfaces with <ref column="type"/> of
1106 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1110 Each tunnel must be uniquely identified by the combination of <ref
1111 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1112 column="options" key="local_ip"/>, and <ref column="options"
1113 key="in_key"/>. If two ports are defined that are the same except one
1114 has an optional identifier and the other does not, the more specific
1115 one is matched first. <ref column="options" key="in_key"/> is
1116 considered more specific than <ref column="options" key="local_ip"/> if
1117 a port defines one and another port defines the other.
1120 <column name="options" key="remote_ip">
1121 Required. The tunnel endpoint.
1124 <column name="options" key="local_ip">
1125 Optional. The destination IP that received packets must
1126 match. Default is to match all addresses.
1129 <column name="options" key="in_key">
1130 <p>Optional. The key that received packets must contain, one of:</p>
1134 <code>0</code>. The tunnel receives packets with no key or with a
1135 key of 0. This is equivalent to specifying no <ref column="options"
1136 key="in_key"/> at all.
1139 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1140 tunnel receives only packets with the specified key.
1143 The word <code>flow</code>. The tunnel accepts packets with any
1144 key. The key will be placed in the <code>tun_id</code> field for
1145 matching in the flow table. The <code>ovs-ofctl</code> manual page
1146 contains additional information about matching fields in OpenFlow
1155 <column name="options" key="out_key">
1156 <p>Optional. The key to be set on outgoing packets, one of:</p>
1160 <code>0</code>. Packets sent through the tunnel will have no key.
1161 This is equivalent to specifying no <ref column="options"
1162 key="out_key"/> at all.
1165 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1166 sent through the tunnel will have the specified key.
1169 The word <code>flow</code>. Packets sent through the tunnel will
1170 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1171 vendor extension (0 is used in the absence of an action). The
1172 <code>ovs-ofctl</code> manual page contains additional information
1173 about the Nicira OpenFlow vendor extensions.
1178 <column name="options" key="key">
1179 Optional. Shorthand to set <code>in_key</code> and
1180 <code>out_key</code> at the same time.
1183 <column name="options" key="tos">
1184 Optional. The value of the ToS bits to be set on the encapsulating
1185 packet. It may also be the word <code>inherit</code>, in which case
1186 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1187 (otherwise it will be 0). The ECN fields are always inherited.
1191 <column name="options" key="ttl">
1192 Optional. The TTL to be set on the encapsulating packet. It may also
1193 be the word <code>inherit</code>, in which case the TTL will be copied
1194 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1195 system default, typically 64). Default is the system default TTL.
1198 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1199 Optional. If enabled, the Don't Fragment bit will be copied from the
1200 inner IP headers (those of the encapsulated traffic) to the outer
1201 (tunnel) headers. Default is disabled; set to <code>true</code> to
1205 <column name="options" key="df_default"
1206 type='{"type": "boolean"}'>
1207 Optional. If enabled, the Don't Fragment bit will be set by default on
1208 tunnel headers if the <code>df_inherit</code> option is not set, or if
1209 the encapsulated packet is not IP. Default is enabled; set to
1210 <code>false</code> to disable.
1213 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1214 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1215 Destination Unreachable - Fragmentation Needed'' messages will be
1216 generated for IPv4 packets with the DF bit set and IPv6 packets above
1217 the minimum MTU if the packet size exceeds the path MTU minus the size
1218 of the tunnel headers. Note that this option causes behavior that is
1219 typically reserved for routers and therefore is not entirely in
1220 compliance with the IEEE 802.1D specification for bridges. Default is
1221 enabled; set to <code>false</code> to disable.
1224 <group title="Tunnel Options: gre only">
1226 Only <code>gre</code> interfaces support these options.
1229 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1230 Enable caching of tunnel headers and the output path. This can lead
1231 to a significant performance increase without changing behavior. In
1232 general it should not be necessary to adjust this setting. However,
1233 the caching can bypass certain components of the IP stack (such as
1234 <code>iptables</code>) and it may be useful to disable it if these
1235 features are required or as a debugging measure. Default is enabled,
1236 set to <code>false</code> to disable.
1240 <group title="Tunnel Options: gre and ipsec_gre only">
1242 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1246 <column name="options" key="csum" type='{"type": "boolean"}'>
1248 Optional. Compute GRE checksums on outgoing packets. Default is
1249 disabled, set to <code>true</code> to enable. Checksums present on
1250 incoming packets will be validated regardless of this setting.
1254 GRE checksums impose a significant performance penalty because they
1255 cover the entire packet. The encapsulated L3, L4, and L7 packet
1256 contents typically have their own checksums, so this additional
1257 checksum only adds value for the GRE and encapsulated L2 headers.
1261 This option is supported for <code>ipsec_gre</code>, but not useful
1262 because GRE checksums are weaker than, and redundant with, IPsec
1263 payload authentication.
1268 <group title="Tunnel Options: ipsec_gre only">
1270 Only <code>ipsec_gre</code> interfaces support these options.
1273 <column name="options" key="peer_cert">
1274 Required for certificate authentication. A string containing the
1275 peer's certificate in PEM format. Additionally the host's
1276 certificate must be specified with the <code>certificate</code>
1280 <column name="options" key="certificate">
1281 Required for certificate authentication. The name of a PEM file
1282 containing a certificate that will be presented to the peer during
1286 <column name="options" key="private_key">
1287 Optional for certificate authentication. The name of a PEM file
1288 containing the private key associated with <code>certificate</code>.
1289 If <code>certificate</code> contains the private key, this option may
1293 <column name="options" key="psk">
1294 Required for pre-shared key authentication. Specifies a pre-shared
1295 key for authentication that must be identical on both sides of the
1301 <group title="Patch Options">
1303 Only <code>patch</code> interfaces support these options.
1306 <column name="options" key="peer">
1307 The <ref column="name"/> of the <ref table="Interface"/> for the other
1308 side of the patch. The named <ref table="Interface"/>'s own
1309 <code>peer</code> option must specify this <ref table="Interface"/>'s
1310 name. That is, the two patch interfaces must have reversed <ref
1311 column="name"/> and <code>peer</code> values.
1315 <group title="Interface Status">
1317 Status information about interfaces attached to bridges, updated every
1318 5 seconds. Not all interfaces have all of these properties; virtual
1319 interfaces don't have a link speed, for example. Non-applicable
1320 columns will have empty values.
1322 <column name="admin_state">
1324 The administrative state of the physical network link.
1328 <column name="link_state">
1330 The observed state of the physical network link. This is ordinarily
1331 the link's carrier status. If the interface's <ref table="Port"/> is
1332 a bond configured for miimon monitoring, it is instead the network
1333 link's miimon status.
1337 <column name="link_resets">
1339 The number of times Open vSwitch has observed the
1340 <ref column="link_state"/> of this <ref table="Interface"/> change.
1344 <column name="link_speed">
1346 The negotiated speed of the physical network link.
1347 Valid values are positive integers greater than 0.
1351 <column name="duplex">
1353 The duplex mode of the physical network link.
1359 The MTU (maximum transmission unit); i.e. the largest
1360 amount of data that can fit into a single Ethernet frame.
1361 The standard Ethernet MTU is 1500 bytes. Some physical media
1362 and many kinds of virtual interfaces can be configured with
1366 This column will be empty for an interface that does not
1367 have an MTU as, for example, some kinds of tunnels do not.
1371 <column name="lacp_current">
1372 Boolean value indicating LACP status for this interface. If true, this
1373 interface has current LACP information about its LACP partner. This
1374 information may be used to monitor the health of interfaces in a LACP
1375 enabled port. This column will be empty if LACP is not enabled.
1378 <column name="status">
1379 Key-value pairs that report port status. Supported status values are
1380 <ref column="type"/>-dependent; some interfaces may not have a valid
1381 <ref column="status" key="driver_name"/>, for example.
1384 <column name="status" key="driver_name">
1385 The name of the device driver controlling the network adapter.
1388 <column name="status" key="driver_version">
1389 The version string of the device driver controlling the network
1393 <column name="status" key="firmware_version">
1394 The version string of the network adapter's firmware, if available.
1397 <column name="status" key="source_ip">
1398 The source IP address used for an IPv4 tunnel end-point, such as
1399 <code>gre</code> or <code>capwap</code>.
1402 <column name="status" key="tunnel_egress_iface">
1403 Egress interface for tunnels. Currently only relevant for GRE and
1404 CAPWAP tunnels. On Linux systems, this column will show the name of
1405 the interface which is responsible for routing traffic destined for the
1406 configured <ref column="options" key="remote_ip"/>. This could be an
1407 internal interface such as a bridge port.
1410 <column name="status" key="tunnel_egress_iface_carrier"
1411 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1412 Whether carrier is detected on <ref column="status"
1413 key="tunnel_egress_iface"/>.
1417 <group title="Statistics">
1419 Key-value pairs that report interface statistics. The current
1420 implementation updates these counters periodically. Future
1421 implementations may update them when an interface is created, when they
1422 are queried (e.g. using an OVSDB <code>select</code> operation), and
1423 just before an interface is deleted due to virtual interface hot-unplug
1424 or VM shutdown, and perhaps at other times, but not on any regular
1428 These are the same statistics reported by OpenFlow in its <code>struct
1429 ofp_port_stats</code> structure. If an interface does not support a
1430 given statistic, then that pair is omitted.
1432 <group title="Statistics: Successful transmit and receive counters">
1433 <column name="statistics" key="rx_packets">
1434 Number of received packets.
1436 <column name="statistics" key="rx_bytes">
1437 Number of received bytes.
1439 <column name="statistics" key="tx_packets">
1440 Number of transmitted packets.
1442 <column name="statistics" key="tx_bytes">
1443 Number of transmitted bytes.
1446 <group title="Statistics: Receive errors">
1447 <column name="statistics" key="rx_dropped">
1448 Number of packets dropped by RX.
1450 <column name="statistics" key="rx_frame_err">
1451 Number of frame alignment errors.
1453 <column name="statistics" key="rx_over_err">
1454 Number of packets with RX overrun.
1456 <column name="statistics" key="rx_crc_err">
1457 Number of CRC errors.
1459 <column name="statistics" key="rx_errors">
1460 Total number of receive errors, greater than or equal to the sum of
1464 <group title="Statistics: Transmit errors">
1465 <column name="statistics" key="tx_dropped">
1466 Number of packets dropped by TX.
1468 <column name="statistics" key="collisions">
1469 Number of collisions.
1471 <column name="statistics" key="tx_errors">
1472 Total number of transmit errors, greater than or equal to the sum of
1478 <group title="Ingress Policing">
1480 These settings control ingress policing for packets received on this
1481 interface. On a physical interface, this limits the rate at which
1482 traffic is allowed into the system from the outside; on a virtual
1483 interface (one connected to a virtual machine), this limits the rate at
1484 which the VM is able to transmit.
1487 Policing is a simple form of quality-of-service that simply drops
1488 packets received in excess of the configured rate. Due to its
1489 simplicity, policing is usually less accurate and less effective than
1490 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1491 table="Queue"/> tables).
1494 Policing is currently implemented only on Linux. The Linux
1495 implementation uses a simple ``token bucket'' approach:
1499 The size of the bucket corresponds to <ref
1500 column="ingress_policing_burst"/>. Initially the bucket is full.
1503 Whenever a packet is received, its size (converted to tokens) is
1504 compared to the number of tokens currently in the bucket. If the
1505 required number of tokens are available, they are removed and the
1506 packet is forwarded. Otherwise, the packet is dropped.
1509 Whenever it is not full, the bucket is refilled with tokens at the
1510 rate specified by <ref column="ingress_policing_rate"/>.
1514 Policing interacts badly with some network protocols, and especially
1515 with fragmented IP packets. Suppose that there is enough network
1516 activity to keep the bucket nearly empty all the time. Then this token
1517 bucket algorithm will forward a single packet every so often, with the
1518 period depending on packet size and on the configured rate. All of the
1519 fragments of an IP packets are normally transmitted back-to-back, as a
1520 group. In such a situation, therefore, only one of these fragments
1521 will be forwarded and the rest will be dropped. IP does not provide
1522 any way for the intended recipient to ask for only the remaining
1523 fragments. In such a case there are two likely possibilities for what
1524 will happen next: either all of the fragments will eventually be
1525 retransmitted (as TCP will do), in which case the same problem will
1526 recur, or the sender will not realize that its packet has been dropped
1527 and data will simply be lost (as some UDP-based protocols will do).
1528 Either way, it is possible that no forward progress will ever occur.
1530 <column name="ingress_policing_rate">
1532 Maximum rate for data received on this interface, in kbps. Data
1533 received faster than this rate is dropped. Set to <code>0</code>
1534 (the default) to disable policing.
1538 <column name="ingress_policing_burst">
1539 <p>Maximum burst size for data received on this interface, in kb. The
1540 default burst size if set to <code>0</code> is 1000 kb. This value
1541 has no effect if <ref column="ingress_policing_rate"/>
1542 is <code>0</code>.</p>
1544 Specifying a larger burst size lets the algorithm be more forgiving,
1545 which is important for protocols like TCP that react severely to
1546 dropped packets. The burst size should be at least the size of the
1547 interface's MTU. Specifying a value that is numerically at least as
1548 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1549 closer to achieving the full rate.
1554 <group title="Connectivity Fault Management">
1556 802.1ag Connectivity Fault Management (CFM) allows a group of
1557 Maintenance Points (MPs) called a Maintenance Association (MA) to
1558 detect connectivity problems with each other. MPs within a MA should
1559 have complete and exclusive interconnectivity. This is verified by
1560 occasionally broadcasting Continuity Check Messages (CCMs) at a
1561 configurable transmission interval.
1565 According to the 802.1ag specification, each Maintenance Point should
1566 be configured out-of-band with a list of Remote Maintenance Points it
1567 should have connectivity to. Open vSwitch differs from the
1568 specification in this area. It simply assumes the link is faulted if
1569 no Remote Maintenance Points are reachable, and considers it not
1573 <column name="cfm_mpid">
1574 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1575 a Maintenance Association. The MPID is used to identify this endpoint
1576 to other Maintenance Points in the MA. Each end of a link being
1577 monitored should have a different MPID. Must be configured to enable
1578 CFM on this <ref table="Interface"/>.
1581 <column name="cfm_fault">
1583 Indicates a connectivity fault triggered by an inability to receive
1584 heartbeats from any remote endpoint. When a fault is triggered on
1585 <ref table="Interface"/>s participating in bonds, they will be
1589 Faults can be triggered for several reasons. Most importantly they
1590 are triggered when no CCMs are received for a period of 3.5 times the
1591 transmission interval. Faults are also triggered when any CCMs
1592 indicate that a Remote Maintenance Point is not receiving CCMs but
1593 able to send them. Finally, a fault is triggered if a CCM is
1594 received which indicates unexpected configuration. Notably, this
1595 case arises when a CCM is received which advertises the local MPID.
1599 <column name="cfm_remote_mpids">
1600 When CFM is properly configured, Open vSwitch will occasionally
1601 receive CCM broadcasts. These broadcasts contain the MPID of the
1602 sending Maintenance Point. The list of MPIDs from which this
1603 <ref table="Interface"/> is receiving broadcasts from is regularly
1604 collected and written to this column.
1607 <column name="other_config" key="cfm_interval"
1608 type='{"type": "integer"}'>
1609 The interval, in milliseconds, between transmissions of CFM heartbeats.
1610 Three missed heartbeat receptions indicate a connectivity fault.
1614 <column name="other_config" key="cfm_extended"
1615 type='{"type": "boolean"}'>
1616 When <code>true</code>, the CFM module operates in extended mode. This
1617 causes it to use a nonstandard destination address to avoid conflicting
1618 with compliant implementations which may be running concurrently on the
1619 network. Furthermore, extended mode increases the accuracy of the
1620 <code>cfm_interval</code> configuration parameter by breaking wire
1621 compatibility with 802.1ag compliant implementations. Defaults to
1624 <column name="other_config" key="cfm_opstate"
1625 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1626 When <code>down</code>, the CFM module marks all CCMs it generates as
1627 operationally down without triggering a fault. This allows remote
1628 maintenance points to choose not to forward traffic to the
1629 <ref table="Interface"/> on which this CFM module is running.
1630 Currently, in Open vSwitch, the opdown bit of CCMs affects
1631 <ref table="Interface"/>s participating in bonds, and the bundle
1632 OpenFlow action. This setting is ignored when CFM is not in extended
1633 mode. Defaults to <code>up</code>.
1637 <group title="Bonding Configuration">
1638 <column name="other_config" key="bond-stable-id"
1639 type='{"type": "integer", "minInteger": 1}'>
1640 Used in <code>stable</code> bond mode to make slave
1641 selection decisions. Allocating <ref column="other_config"
1642 key="bond-stable-id"/> values consistently across interfaces
1643 participating in a bond will guarantee consistent slave selection
1644 decisions across <code>ovs-vswitchd</code> instances when using
1645 <code>stable</code> bonding mode.
1648 <column name="other_config" key="lacp-port-id"
1649 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1650 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1651 used in LACP negotiations to identify individual ports
1652 participating in a bond.
1655 <column name="other_config" key="lacp-port-priority"
1656 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1657 The LACP port priority of this <ref table="Interface"/>. In LACP
1658 negotiations <ref table="Interface"/>s with numerically lower
1659 priorities are preferred for aggregation.
1662 <column name="other_config" key="lacp-aggregation-key"
1663 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1664 The LACP aggregation key of this <ref table="Interface"/>. <ref
1665 table="Interface"/>s with different aggregation keys may not be active
1666 within a given <ref table="Port"/> at the same time.
1670 <group title="Virtual Machine Identifiers">
1672 These key-value pairs specifically apply to an interface that
1673 represents a virtual Ethernet interface connected to a virtual
1674 machine. These key-value pairs should not be present for other types
1675 of interfaces. Keys whose names end in <code>-uuid</code> have
1676 values that uniquely identify the entity in question. For a Citrix
1677 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1678 Other hypervisors may use other formats.
1681 <column name="external_ids" key="attached-mac">
1682 The MAC address programmed into the ``virtual hardware'' for this
1683 interface, in the form
1684 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1685 For Citrix XenServer, this is the value of the <code>MAC</code> field
1686 in the VIF record for this interface.
1689 <column name="external_ids" key="iface-id">
1690 A system-unique identifier for the interface. On XenServer, this will
1691 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1694 <column name="external_ids" key="xs-vif-uuid">
1695 The virtual interface associated with this interface.
1698 <column name="external_ids" key="xs-network-uuid">
1699 The virtual network to which this interface is attached.
1702 <column name="external_ids" key="xs-vm-uuid">
1703 The VM to which this interface belongs.
1707 <group title="Common Columns">
1708 The overall purpose of these columns is described under <code>Common
1709 Columns</code> at the beginning of this document.
1711 <column name="other_config"/>
1712 <column name="external_ids"/>
1716 <table name="QoS" title="Quality of Service configuration">
1717 <p>Quality of Service (QoS) configuration for each Port that
1720 <column name="type">
1721 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1722 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1723 identifies the types that a switch actually supports. The currently
1724 defined types are listed below:</p>
1726 <dt><code>linux-htb</code></dt>
1728 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1729 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1730 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1731 for information on how this classifier works and how to configure it.
1735 <dt><code>linux-hfsc</code></dt>
1737 Linux "Hierarchical Fair Service Curve" classifier.
1738 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1739 information on how this classifier works.
1744 <column name="queues">
1745 <p>A map from queue numbers to <ref table="Queue"/> records. The
1746 supported range of queue numbers depend on <ref column="type"/>. The
1747 queue numbers are the same as the <code>queue_id</code> used in
1748 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1749 structures. Queue 0 is used by OpenFlow output actions that do not
1750 specify a specific queue.</p>
1753 <group title="Configuration for linux-htb and linux-hfsc">
1755 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1756 the following key-value pair:
1759 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
1760 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
1761 specified, for physical interfaces, the default is the link rate. For
1762 other interfaces or if the link rate cannot be determined, the default
1763 is currently 100 Mbps.
1767 <group title="Common Columns">
1768 The overall purpose of these columns is described under <code>Common
1769 Columns</code> at the beginning of this document.
1771 <column name="other_config"/>
1772 <column name="external_ids"/>
1776 <table name="Queue" title="QoS output queue.">
1777 <p>A configuration for a port output queue, used in configuring Quality of
1778 Service (QoS) features. May be referenced by <ref column="queues"
1779 table="QoS"/> column in <ref table="QoS"/> table.</p>
1781 <group title="Configuration for min-rate QoS">
1783 These key-value pairs are defined for <ref table="QoS"/> <ref
1784 table="QoS" column="type"/> of <code>min-rate</code>.
1787 <column name="other_config" key="min-rate"
1788 type='{"type": "integer", "minInteger": 12000}'>
1789 Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
1790 1500 bytes/s (12,000 bit/s).
1794 <group title="Configuration for linux-htb QoS">
1796 These key-value pairs are defined for <ref table="QoS"/> <ref
1797 table="QoS" column="type"/> of <code>linux-htb</code>.
1800 <column name="other_config" key="min-rate"
1801 type='{"type": "integer", "minInteger": 1}'>
1802 Minimum guaranteed bandwidth, in bit/s.
1805 <column name="other_config" key="max-rate"
1806 type='{"type": "integer", "minInteger": 1}'>
1807 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1808 queue's rate will not be allowed to exceed the specified value, even
1809 if excess bandwidth is available. If unspecified, defaults to no
1813 <column name="other_config" key="burst"
1814 type='{"type": "integer", "minInteger": 1}'>
1815 Burst size, in bits. This is the maximum amount of ``credits'' that a
1816 queue can accumulate while it is idle. Optional. Details of the
1817 <code>linux-htb</code> implementation require a minimum burst size, so
1818 a too-small <code>burst</code> will be silently ignored.
1821 <column name="other_config" key="priority"
1822 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
1823 A queue with a smaller <code>priority</code> will receive all the
1824 excess bandwidth that it can use before a queue with a larger value
1825 receives any. Specific priority values are unimportant; only relative
1826 ordering matters. Defaults to 0 if unspecified.
1830 <group title="Configuration for linux-hfsc QoS">
1832 These key-value pairs are defined for <ref table="QoS"/> <ref
1833 table="QoS" column="type"/> of <code>linux-hfsc</code>.
1836 <column name="other_config" key="min-rate"
1837 type='{"type": "integer", "minInteger": 1}'>
1838 Minimum guaranteed bandwidth, in bit/s.
1841 <column name="other_config" key="max-rate"
1842 type='{"type": "integer", "minInteger": 1}'>
1843 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1844 queue's rate will not be allowed to exceed the specified value, even if
1845 excess bandwidth is available. If unspecified, defaults to no
1850 <group title="Common Columns">
1851 The overall purpose of these columns is described under <code>Common
1852 Columns</code> at the beginning of this document.
1854 <column name="other_config"/>
1855 <column name="external_ids"/>
1859 <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
1860 <p>A port mirror within a <ref table="Bridge"/>.</p>
1861 <p>A port mirror configures a bridge to send selected frames to special
1862 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1863 traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
1864 the mirrored traffic is sent.</p>
1866 <column name="name">
1867 Arbitrary identifier for the <ref table="Mirror"/>.
1870 <group title="Selecting Packets for Mirroring">
1872 To be selected for mirroring, a given packet must enter or leave the
1873 bridge through a selected port and it must also be in one of the
1877 <column name="select_all">
1878 If true, every packet arriving or departing on any port is
1879 selected for mirroring.
1882 <column name="select_dst_port">
1883 Ports on which departing packets are selected for mirroring.
1886 <column name="select_src_port">
1887 Ports on which arriving packets are selected for mirroring.
1890 <column name="select_vlan">
1891 VLANs on which packets are selected for mirroring. An empty set
1892 selects packets on all VLANs.
1896 <group title="Mirroring Destination Configuration">
1898 These columns are mutually exclusive. Exactly one of them must be
1902 <column name="output_port">
1903 <p>Output port for selected packets, if nonempty.</p>
1904 <p>Specifying a port for mirror output reserves that port exclusively
1905 for mirroring. No frames other than those selected for mirroring
1906 will be forwarded to the port, and any frames received on the port
1907 will be discarded.</p>
1909 The output port may be any kind of port supported by Open vSwitch.
1910 It may be, for example, a physical port (sometimes called SPAN), or a
1911 GRE tunnel (sometimes called ERSPAN).
1915 <column name="output_vlan">
1916 <p>Output VLAN for selected packets, if nonempty.</p>
1917 <p>The frames will be sent out all ports that trunk
1918 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1919 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1920 trunk port, the frame's VLAN tag will be set to
1921 <ref column="output_vlan"/>, replacing any existing tag; when it is
1922 sent out an implicit VLAN port, the frame will not be tagged. This
1923 type of mirroring is sometimes called RSPAN.</p>
1925 The following destination MAC addresses will not be mirrored to a
1926 VLAN to avoid confusing switches that interpret the protocols that
1930 <dt><code>01:80:c2:00:00:00</code></dt>
1931 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1933 <dt><code>01:80:c2:00:00:01</code></dt>
1934 <dd>IEEE Pause frame.</dd>
1936 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1937 <dd>Other reserved protocols.</dd>
1939 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1941 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1942 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1946 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1947 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1949 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1950 <dd>Cisco STP Uplink Fast.</dd>
1952 <dt><code>01:00:0c:00:00:00</code></dt>
1953 <dd>Cisco Inter Switch Link.</dd>
1955 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1956 contains unmanaged switches. Consider an unmanaged physical switch
1957 with two ports: port 1, connected to an end host, and port 2,
1958 connected to an Open vSwitch configured to mirror received packets
1959 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1960 port 1 that the physical switch forwards to port 2. The Open vSwitch
1961 forwards this packet to its destination and then reflects it back on
1962 port 2 in VLAN 123. This reflected packet causes the unmanaged
1963 physical switch to replace the MAC learning table entry, which
1964 correctly pointed to port 1, with one that incorrectly points to port
1965 2. Afterward, the physical switch will direct packets destined for
1966 the end host to the Open vSwitch on port 2, instead of to the end
1967 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1968 desired in this scenario, then the physical switch must be replaced
1969 by one that learns Ethernet addresses on a per-VLAN basis. In
1970 addition, learning should be disabled on the VLAN containing mirrored
1971 traffic. If this is not done then intermediate switches will learn
1972 the MAC address of each end host from the mirrored traffic. If
1973 packets being sent to that end host are also mirrored, then they will
1974 be dropped since the switch will attempt to send them out the input
1975 port. Disabling learning for the VLAN will cause the switch to
1976 correctly send the packet out all ports configured for that VLAN. If
1977 Open vSwitch is being used as an intermediate switch, learning can be
1978 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1979 in the appropriate <ref table="Bridge"/> table or tables.</p>
1981 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
1982 VLAN and should generally be preferred.
1987 <group title="Common Columns">
1988 The overall purpose of these columns is described under <code>Common
1989 Columns</code> at the beginning of this document.
1991 <column name="external_ids"/>
1995 <table name="Controller" title="OpenFlow controller configuration.">
1996 <p>An OpenFlow controller.</p>
1999 Open vSwitch supports two kinds of OpenFlow controllers:
2003 <dt>Primary controllers</dt>
2006 This is the kind of controller envisioned by the OpenFlow 1.0
2007 specification. Usually, a primary controller implements a network
2008 policy by taking charge of the switch's flow table.
2012 Open vSwitch initiates and maintains persistent connections to
2013 primary controllers, retrying the connection each time it fails or
2014 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2015 <ref table="Bridge"/> table applies to primary controllers.
2019 Open vSwitch permits a bridge to have any number of primary
2020 controllers. When multiple controllers are configured, Open
2021 vSwitch connects to all of them simultaneously. Because
2022 OpenFlow 1.0 does not specify how multiple controllers
2023 coordinate in interacting with a single switch, more than
2024 one primary controller should be specified only if the
2025 controllers are themselves designed to coordinate with each
2026 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2027 vendor extension may be useful for this.)
2030 <dt>Service controllers</dt>
2033 These kinds of OpenFlow controller connections are intended for
2034 occasional support and maintenance use, e.g. with
2035 <code>ovs-ofctl</code>. Usually a service controller connects only
2036 briefly to inspect or modify some of a switch's state.
2040 Open vSwitch listens for incoming connections from service
2041 controllers. The service controllers initiate and, if necessary,
2042 maintain the connections from their end. The <ref table="Bridge"
2043 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2044 not apply to service controllers.
2048 Open vSwitch supports configuring any number of service controllers.
2054 The <ref column="target"/> determines the type of controller.
2057 <group title="Core Features">
2058 <column name="target">
2059 <p>Connection method for controller.</p>
2061 The following connection methods are currently supported for primary
2065 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2067 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2068 the given <var>ip</var>, which must be expressed as an IP address
2069 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2070 column in the <ref table="Open_vSwitch"/> table must point to a
2071 valid SSL configuration when this form is used.</p>
2072 <p>SSL support is an optional feature that is not always built as
2073 part of Open vSwitch.</p>
2075 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2076 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2077 the given <var>ip</var>, which must be expressed as an IP address
2078 (not a DNS name).</dd>
2081 The following connection methods are currently supported for service
2085 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2088 Listens for SSL connections on the specified TCP <var>port</var>
2089 (default: 6633). If <var>ip</var>, which must be expressed as an
2090 IP address (not a DNS name), is specified, then connections are
2091 restricted to the specified local IP address.
2094 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2095 table="Open_vSwitch"/> table must point to a valid SSL
2096 configuration when this form is used.
2098 <p>SSL support is an optional feature that is not always built as
2099 part of Open vSwitch.</p>
2101 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2103 Listens for connections on the specified TCP <var>port</var>
2104 (default: 6633). If <var>ip</var>, which must be expressed as an
2105 IP address (not a DNS name), is specified, then connections are
2106 restricted to the specified local IP address.
2109 <p>When multiple controllers are configured for a single bridge, the
2110 <ref column="target"/> values must be unique. Duplicate
2111 <ref column="target"/> values yield unspecified results.</p>
2114 <column name="connection_mode">
2115 <p>If it is specified, this setting must be one of the following
2116 strings that describes how Open vSwitch contacts this OpenFlow
2117 controller over the network:</p>
2120 <dt><code>in-band</code></dt>
2121 <dd>In this mode, this controller's OpenFlow traffic travels over the
2122 bridge associated with the controller. With this setting, Open
2123 vSwitch allows traffic to and from the controller regardless of the
2124 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2125 would never be able to connect to the controller, because it did
2126 not have a flow to enable it.) This is the most common connection
2127 mode because it is not necessary to maintain two independent
2129 <dt><code>out-of-band</code></dt>
2130 <dd>In this mode, OpenFlow traffic uses a control network separate
2131 from the bridge associated with this controller, that is, the
2132 bridge does not use any of its own network devices to communicate
2133 with the controller. The control network must be configured
2134 separately, before or after <code>ovs-vswitchd</code> is started.
2138 <p>If not specified, the default is implementation-specific.</p>
2142 <group title="Controller Failure Detection and Handling">
2143 <column name="max_backoff">
2144 Maximum number of milliseconds to wait between connection attempts.
2145 Default is implementation-specific.
2148 <column name="inactivity_probe">
2149 Maximum number of milliseconds of idle time on connection to
2150 controller before sending an inactivity probe message. If Open
2151 vSwitch does not communicate with the controller for the specified
2152 number of seconds, it will send a probe. If a response is not
2153 received for the same additional amount of time, Open vSwitch
2154 assumes the connection has been broken and attempts to reconnect.
2155 Default is implementation-specific. A value of 0 disables
2160 <group title="OpenFlow Rate Limiting">
2161 <column name="controller_rate_limit">
2162 <p>The maximum rate at which packets in unknown flows will be
2163 forwarded to the OpenFlow controller, in packets per second. This
2164 feature prevents a single bridge from overwhelming the controller.
2165 If not specified, the default is implementation-specific.</p>
2166 <p>In addition, when a high rate triggers rate-limiting, Open
2167 vSwitch queues controller packets for each port and transmits
2168 them to the controller at the configured rate. The number of
2169 queued packets is limited by
2170 the <ref column="controller_burst_limit"/> value. The packet
2171 queue is shared fairly among the ports on a bridge.</p><p>Open
2172 vSwitch maintains two such packet rate-limiters per bridge.
2173 One of these applies to packets sent up to the controller
2174 because they do not correspond to any flow. The other applies
2175 to packets sent up to the controller by request through flow
2176 actions. When both rate-limiters are filled with packets, the
2177 actual rate that packets are sent to the controller is up to
2178 twice the specified rate.</p>
2181 <column name="controller_burst_limit">
2182 In conjunction with <ref column="controller_rate_limit"/>,
2183 the maximum number of unused packet credits that the bridge will
2184 allow to accumulate, in packets. If not specified, the default
2185 is implementation-specific.
2189 <group title="Additional In-Band Configuration">
2190 <p>These values are considered only in in-band control mode (see
2191 <ref column="connection_mode"/>).</p>
2193 <p>When multiple controllers are configured on a single bridge, there
2194 should be only one set of unique values in these columns. If different
2195 values are set for these columns in different controllers, the effect
2198 <column name="local_ip">
2199 The IP address to configure on the local port,
2200 e.g. <code>192.168.0.123</code>. If this value is unset, then
2201 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2205 <column name="local_netmask">
2206 The IP netmask to configure on the local port,
2207 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2208 but this value is unset, then the default is chosen based on whether
2209 the IP address is class A, B, or C.
2212 <column name="local_gateway">
2213 The IP address of the gateway to configure on the local port, as a
2214 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2215 this network has no gateway.
2219 <group title="Controller Status">
2220 <column name="is_connected">
2221 <code>true</code> if currently connected to this controller,
2222 <code>false</code> otherwise.
2226 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2227 <p>The level of authority this controller has on the associated
2228 bridge. Possible values are:</p>
2230 <dt><code>other</code></dt>
2231 <dd>Allows the controller access to all OpenFlow features.</dd>
2232 <dt><code>master</code></dt>
2233 <dd>Equivalent to <code>other</code>, except that there may be at
2234 most one master controller at a time. When a controller configures
2235 itself as <code>master</code>, any existing master is demoted to
2236 the <code>slave</code>role.</dd>
2237 <dt><code>slave</code></dt>
2238 <dd>Allows the controller read-only access to OpenFlow features.
2239 Attempts to modify the flow table will be rejected with an
2240 error. Slave controllers do not receive OFPT_PACKET_IN or
2241 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2246 <column name="status" key="last_error">
2247 A human-readable description of the last error on the connection
2248 to the controller; i.e. <code>strerror(errno)</code>. This key
2249 will exist only if an error has occurred.
2252 <column name="status" key="state"
2253 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2255 The state of the connection to the controller:
2258 <dt><code>VOID</code></dt>
2259 <dd>Connection is disabled.</dd>
2261 <dt><code>BACKOFF</code></dt>
2262 <dd>Attempting to reconnect at an increasing period.</dd>
2264 <dt><code>CONNECTING</code></dt>
2265 <dd>Attempting to connect.</dd>
2267 <dt><code>ACTIVE</code></dt>
2268 <dd>Connected, remote host responsive.</dd>
2270 <dt><code>IDLE</code></dt>
2271 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2274 These values may change in the future. They are provided only for
2279 <column name="status" key="sec_since_connect"
2280 type='{"type": "integer", "minInteger": 0}'>
2281 The amount of time since this controller last successfully connected to
2282 the switch (in seconds). Value is empty if controller has never
2283 successfully connected.
2286 <column name="status" key="sec_since_disconnect"
2287 type='{"type": "integer", "minInteger": 1}'>
2288 The amount of time since this controller last disconnected from
2289 the switch (in seconds). Value is empty if controller has never
2294 <group title="Common Columns">
2295 The overall purpose of these columns is described under <code>Common
2296 Columns</code> at the beginning of this document.
2298 <column name="external_ids"/>
2302 <table name="Manager" title="OVSDB management connection.">
2304 Configuration for a database connection to an Open vSwitch database
2309 This table primarily configures the Open vSwitch database
2310 (<code>ovsdb-server</code>), not the Open vSwitch switch
2311 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2312 what connections should be treated as in-band.
2316 The Open vSwitch database server can initiate and maintain active
2317 connections to remote clients. It can also listen for database
2321 <group title="Core Features">
2322 <column name="target">
2323 <p>Connection method for managers.</p>
2325 The following connection methods are currently supported:
2328 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2331 The specified SSL <var>port</var> (default: 6632) on the host at
2332 the given <var>ip</var>, which must be expressed as an IP address
2333 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2334 column in the <ref table="Open_vSwitch"/> table must point to a
2335 valid SSL configuration when this form is used.
2338 SSL support is an optional feature that is not always built as
2339 part of Open vSwitch.
2343 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2345 The specified TCP <var>port</var> (default: 6632) on the host at
2346 the given <var>ip</var>, which must be expressed as an IP address
2349 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2352 Listens for SSL connections on the specified TCP <var>port</var>
2353 (default: 6632). If <var>ip</var>, which must be expressed as an
2354 IP address (not a DNS name), is specified, then connections are
2355 restricted to the specified local IP address.
2358 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2359 table="Open_vSwitch"/> table must point to a valid SSL
2360 configuration when this form is used.
2363 SSL support is an optional feature that is not always built as
2364 part of Open vSwitch.
2367 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2369 Listens for connections on the specified TCP <var>port</var>
2370 (default: 6632). If <var>ip</var>, which must be expressed as an
2371 IP address (not a DNS name), is specified, then connections are
2372 restricted to the specified local IP address.
2375 <p>When multiple managers are configured, the <ref column="target"/>
2376 values must be unique. Duplicate <ref column="target"/> values yield
2377 unspecified results.</p>
2380 <column name="connection_mode">
2382 If it is specified, this setting must be one of the following strings
2383 that describes how Open vSwitch contacts this OVSDB client over the
2388 <dt><code>in-band</code></dt>
2390 In this mode, this connection's traffic travels over a bridge
2391 managed by Open vSwitch. With this setting, Open vSwitch allows
2392 traffic to and from the client regardless of the contents of the
2393 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2394 to connect to the client, because it did not have a flow to enable
2395 it.) This is the most common connection mode because it is not
2396 necessary to maintain two independent networks.
2398 <dt><code>out-of-band</code></dt>
2400 In this mode, the client's traffic uses a control network separate
2401 from that managed by Open vSwitch, that is, Open vSwitch does not
2402 use any of its own network devices to communicate with the client.
2403 The control network must be configured separately, before or after
2404 <code>ovs-vswitchd</code> is started.
2409 If not specified, the default is implementation-specific.
2414 <group title="Client Failure Detection and Handling">
2415 <column name="max_backoff">
2416 Maximum number of milliseconds to wait between connection attempts.
2417 Default is implementation-specific.
2420 <column name="inactivity_probe">
2421 Maximum number of milliseconds of idle time on connection to the client
2422 before sending an inactivity probe message. If Open vSwitch does not
2423 communicate with the client for the specified number of seconds, it
2424 will send a probe. If a response is not received for the same
2425 additional amount of time, Open vSwitch assumes the connection has been
2426 broken and attempts to reconnect. Default is implementation-specific.
2427 A value of 0 disables inactivity probes.
2431 <group title="Status">
2432 <column name="is_connected">
2433 <code>true</code> if currently connected to this manager,
2434 <code>false</code> otherwise.
2437 <column name="status" key="last_error">
2438 A human-readable description of the last error on the connection
2439 to the manager; i.e. <code>strerror(errno)</code>. This key
2440 will exist only if an error has occurred.
2443 <column name="status" key="state"
2444 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2446 The state of the connection to the manager:
2449 <dt><code>VOID</code></dt>
2450 <dd>Connection is disabled.</dd>
2452 <dt><code>BACKOFF</code></dt>
2453 <dd>Attempting to reconnect at an increasing period.</dd>
2455 <dt><code>CONNECTING</code></dt>
2456 <dd>Attempting to connect.</dd>
2458 <dt><code>ACTIVE</code></dt>
2459 <dd>Connected, remote host responsive.</dd>
2461 <dt><code>IDLE</code></dt>
2462 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2465 These values may change in the future. They are provided only for
2470 <column name="status" key="sec_since_connect"
2471 type='{"type": "integer", "minInteger": 0}'>
2472 The amount of time since this manager last successfully connected
2473 to the database (in seconds). Value is empty if manager has never
2474 successfully connected.
2477 <column name="status" key="sec_since_disconnect"
2478 type='{"type": "integer", "minInteger": 0}'>
2479 The amount of time since this manager last disconnected from the
2480 database (in seconds). Value is empty if manager has never
2484 <column name="status" key="locks_held">
2485 Space-separated list of the names of OVSDB locks that the connection
2486 holds. Omitted if the connection does not hold any locks.
2489 <column name="status" key="locks_waiting">
2490 Space-separated list of the names of OVSDB locks that the connection is
2491 currently waiting to acquire. Omitted if the connection is not waiting
2495 <column name="status" key="locks_lost">
2496 Space-separated list of the names of OVSDB locks that the connection
2497 has had stolen by another OVSDB client. Omitted if no locks have been
2498 stolen from this connection.
2501 <column name="status" key="n_connections"
2502 type='{"type": "integer", "minInteger": 2}'>
2504 When <ref column="target"/> specifies a connection method that
2505 listens for inbound connections (e.g. <code>ptcp:</code> or
2506 <code>pssl:</code>) and more than one connection is actually active,
2507 the value is the number of active connections. Otherwise, this
2508 key-value pair is omitted.
2511 When multiple connections are active, status columns and key-value
2512 pairs (other than this one) report the status of one arbitrarily
2518 <group title="Common Columns">
2519 The overall purpose of these columns is described under <code>Common
2520 Columns</code> at the beginning of this document.
2522 <column name="external_ids"/>
2526 <table name="NetFlow">
2527 A NetFlow target. NetFlow is a protocol that exports a number of
2528 details about terminating IP flows, such as the principals involved
2531 <column name="targets">
2532 NetFlow targets in the form
2533 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2534 must be specified numerically, not as a DNS name.
2537 <column name="engine_id">
2538 Engine ID to use in NetFlow messages. Defaults to datapath index
2542 <column name="engine_type">
2543 Engine type to use in NetFlow messages. Defaults to datapath
2544 index if not specified.
2547 <column name="active_timeout">
2548 The interval at which NetFlow records are sent for flows that are
2549 still active, in seconds. A value of <code>0</code> requests the
2550 default timeout (currently 600 seconds); a value of <code>-1</code>
2551 disables active timeouts.
2554 <column name="add_id_to_interface">
2555 <p>If this column's value is <code>false</code>, the ingress and egress
2556 interface fields of NetFlow flow records are derived from OpenFlow port
2557 numbers. When it is <code>true</code>, the 7 most significant bits of
2558 these fields will be replaced by the least significant 7 bits of the
2559 engine id. This is useful because many NetFlow collectors do not
2560 expect multiple switches to be sending messages from the same host, so
2561 they do not store the engine information which could be used to
2562 disambiguate the traffic.</p>
2563 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2566 <group title="Common Columns">
2567 The overall purpose of these columns is described under <code>Common
2568 Columns</code> at the beginning of this document.
2570 <column name="external_ids"/>
2575 SSL configuration for an Open_vSwitch.
2577 <column name="private_key">
2578 Name of a PEM file containing the private key used as the switch's
2579 identity for SSL connections to the controller.
2582 <column name="certificate">
2583 Name of a PEM file containing a certificate, signed by the
2584 certificate authority (CA) used by the controller and manager,
2585 that certifies the switch's private key, identifying a trustworthy
2589 <column name="ca_cert">
2590 Name of a PEM file containing the CA certificate used to verify
2591 that the switch is connected to a trustworthy controller.
2594 <column name="bootstrap_ca_cert">
2595 If set to <code>true</code>, then Open vSwitch will attempt to
2596 obtain the CA certificate from the controller on its first SSL
2597 connection and save it to the named PEM file. If it is successful,
2598 it will immediately drop the connection and reconnect, and from then
2599 on all SSL connections must be authenticated by a certificate signed
2600 by the CA certificate thus obtained. <em>This option exposes the
2601 SSL connection to a man-in-the-middle attack obtaining the initial
2602 CA certificate.</em> It may still be useful for bootstrapping.
2605 <group title="Common Columns">
2606 The overall purpose of these columns is described under <code>Common
2607 Columns</code> at the beginning of this document.
2609 <column name="external_ids"/>
2613 <table name="sFlow">
2614 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2617 <column name="agent">
2618 Name of the network device whose IP address should be reported as the
2619 ``agent address'' to collectors. If not specified, the IP address
2620 defaults to the <ref table="Controller" column="local_ip"/> in the
2621 collector's <ref table="Controller"/>. If an agent IP address cannot be
2622 determined either way, sFlow is disabled.
2625 <column name="header">
2626 Number of bytes of a sampled packet to send to the collector.
2627 If not specified, the default is 128 bytes.
2630 <column name="polling">
2631 Polling rate in seconds to send port statistics to the collector.
2632 If not specified, defaults to 30 seconds.
2635 <column name="sampling">
2636 Rate at which packets should be sampled and sent to the collector.
2637 If not specified, defaults to 400, which means one out of 400
2638 packets, on average, will be sent to the collector.
2641 <column name="targets">
2642 sFlow targets in the form
2643 <code><var>ip</var>:<var>port</var></code>.
2646 <group title="Common Columns">
2647 The overall purpose of these columns is described under <code>Common
2648 Columns</code> at the beginning of this document.
2650 <column name="external_ids"/>
2654 <table name="Capability">
2655 <p>Records in this table describe functionality supported by the hardware
2656 and software platform on which this Open vSwitch is based. Clients
2657 should not modify this table.</p>
2659 <p>A record in this table is meaningful only if it is referenced by the
2660 <ref table="Open_vSwitch" column="capabilities"/> column in the
2661 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2662 the record's ``category,'' determines the meanings of the
2663 <ref column="details"/> column. The following general forms of
2664 categories are currently defined:</p>
2667 <dt><code>qos-<var>type</var></code></dt>
2668 <dd><var>type</var> is supported as the value for
2669 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2673 <column name="details">
2674 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2675 depends on the category key that the <ref table="Open_vSwitch"
2676 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2677 uses to reference this record, as described above.</p>
2679 <p>The presence of a record for category <code>qos-<var>type</var></code>
2680 indicates that the switch supports <var>type</var> as the value of
2681 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2682 table. The following key-value pairs are defined to further describe
2683 QoS capabilities:</p>
2686 <dt><code>n-queues</code></dt>
2687 <dd>Number of supported queues, as a positive integer. Keys in the
2688 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2689 records whose <ref table="QoS" column="type"/> value
2690 equals <var>type</var> must range between 0 and this value minus one,