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="Other Features">
439 <column name="datapath_type">
440 Name of datapath provider. The kernel datapath has
441 type <code>system</code>. The userspace datapath has
442 type <code>netdev</code>.
445 <column name="external_ids" key="bridge-id">
446 A unique identifier of the bridge. On Citrix XenServer this will
447 commonly be the same as
448 <ref column="external_ids" key="xs-network-uuids"/>.
451 <column name="external_ids" key="xs-network-uuids">
452 Semicolon-delimited set of universally unique identifier(s) for the
453 network with which this bridge is associated on a Citrix XenServer
454 host. The network identifiers are RFC 4122 UUIDs as displayed by,
455 e.g., <code>xe network-list</code>.
458 <column name="other_config" key="hwaddr">
459 An Ethernet address in the form
460 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
461 to set the hardware address of the local port and influence the
465 <column name="other_config" key="flow-eviction-threshold"
466 type='{"type": "integer", "minInteger": 0}'>
468 A number of flows as a nonnegative integer. This sets number of
469 flows at which eviction from the kernel flow table will be triggered.
470 If there are a large number of flows then increasing this value to
471 around the number of flows present can result in reduced CPU usage
475 The default is 1000. Values below 100 will be rounded up to 100.
479 <column name="other_config" key="forward-bpdu"
480 type='{"type": "boolean"}'>
481 Option to allow forwarding of BPDU frames when NORMAL action if
482 invoked. Frames with reserved Ethernet addresses (e.g. STP BPDU) will
483 be forwarded when this option is enabled. If the Open vSwitch bridge
484 is used to connect different Ethernet networks, and if Open vSwitch
485 node does not run STP, then this option should be enabled. Default is
486 disabled, set to <code>true</code> to enable.
490 <group title="Common Columns">
491 The overall purpose of these columns is described under <code>Common
492 Columns</code> at the beginning of this document.
494 <column name="other_config"/>
495 <column name="external_ids"/>
499 <table name="Port" table="Port or bond configuration.">
500 <p>A port within a <ref table="Bridge"/>.</p>
501 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
502 <ref column="interfaces"/> column. Such a port logically
503 corresponds to a port on a physical Ethernet switch. A port
504 with more than one interface is a ``bonded port'' (see
505 <ref group="Bonding Configuration"/>).</p>
506 <p>Some properties that one might think as belonging to a port are actually
507 part of the port's <ref table="Interface"/> members.</p>
510 Port name. Should be alphanumeric and no more than about 8
511 bytes long. May be the same as the interface name, for
512 non-bonded ports. Must otherwise be unique among the names of
513 ports, interfaces, and bridges on a host.
516 <column name="interfaces">
517 The port's interfaces. If there is more than one, this is a
521 <group title="VLAN Configuration">
522 <p>Bridge ports support the following types of VLAN configuration:</p>
527 A trunk port carries packets on one or more specified VLANs
528 specified in the <ref column="trunks"/> column (often, on every
529 VLAN). A packet that ingresses on a trunk port is in the VLAN
530 specified in its 802.1Q header, or VLAN 0 if the packet has no
531 802.1Q header. A packet that egresses through a trunk port will
532 have a 802.1Q header if it has a nonzero VLAN ID (or a nonzero
537 Any packet that ingresses on a trunk port tagged with a VLAN that
538 the port does not trunk is dropped.
545 An access port carries packets on exactly one VLAN specified in the
546 <ref column="tag"/> column. Packets ingressing and egressing on an
547 access port have no 802.1Q header.
551 Any packet with an 802.1Q header that ingresses on an access port
552 is dropped, regardless of whether the VLAN ID in the header is the
553 access port's VLAN ID.
557 <dt>native-tagged</dt>
559 A native-tagged port resembles a trunk port, with the exception that
560 a packet without an 802.1Q header that ingresses on a native-tagged
561 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
565 <dt>native-untagged</dt>
567 A native-untagged port resembles a native-tagged port, with the
568 exception that a packet that egresses on a native-untagged port in
569 the native VLAN not have an 802.1Q header.
573 A packet will only egress through bridge ports that carry the VLAN of
574 the packet, as described by the rules above.
577 <column name="vlan_mode">
579 The VLAN mode of the port, as described above. When this column is
580 empty, a default mode is selected as follows:
584 If <ref column="tag"/> contains a value, the port is an access
585 port. The <ref column="trunks"/> column should be empty.
588 Otherwise, the port is a trunk port. The <ref column="trunks"/>
589 column value is honored if it is present.
596 For an access port, the port's implicitly tagged VLAN. For a
597 native-tagged or native-untagged port, the port's native VLAN. Must
598 be empty if this is a trunk port.
602 <column name="trunks">
604 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
605 or VLANs that this port trunks; if it is empty, then the port trunks
606 all VLANs. Must be empty if this is an access port.
609 A native-tagged or native-untagged port always trunks its native
610 VLAN, regardless of whether <ref column="trunks"/> includes that
616 <group title="Bonding Configuration">
617 <p>A port that has more than one interface is a ``bonded port.'' Bonding
618 allows for load balancing and fail-over. Some kinds of bonding will
619 work with any kind of upstream switch:</p>
622 <dt><code>balance-slb</code></dt>
624 Balances flows among slaves based on source MAC address and output
625 VLAN, with periodic rebalancing as traffic patterns change.
628 <dt><code>active-backup</code></dt>
630 Assigns all flows to one slave, failing over to a backup slave when
631 the active slave is disabled.
636 The following modes require the upstream switch to support 802.3ad with
637 successful LACP negotiation. If LACP negotiation fails then
638 <code>balance-slb</code> style flow hashing is used as a fallback:
642 <dt><code>balance-tcp</code></dt>
644 Balances flows among slaves based on L2, L3, and L4 protocol
645 information such as destination MAC address, IP address, and TCP
649 <dt><code>stable</code></dt>
651 <p>Attempts to always assign a given flow to the same slave
652 consistently. In an effort to maintain stability, no load
653 balancing is done. Uses a similar hashing strategy to
654 <code>balance-tcp</code>, always taking into account L3 and L4
655 fields even if LACP negotiations are unsuccessful. </p>
656 <p>Slave selection decisions are made based on <ref table="Interface"
657 column="other_config" key="bond-stable-id"/> if set. Otherwise,
658 OpenFlow port number is used. Decisions are consistent across all
659 <code>ovs-vswitchd</code> instances with equivalent
660 <ref table="Interface" column="other_config" key="bond-stable-id"/>
665 <p>These columns apply only to bonded ports. Their values are
666 otherwise ignored.</p>
668 <column name="bond_mode">
669 <p>The type of bonding used for a bonded port. Defaults to
670 <code>balance-slb</code> if unset.
674 <group title="Link Failure Detection">
676 An important part of link bonding is detecting that links are down so
677 that they may be disabled. These settings determine how Open vSwitch
678 detects link failure.
681 <column name="other_config" key="bond-detect-mode"
682 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
683 The means used to detect link failures. Defaults to
684 <code>carrier</code> which uses each interface's carrier to detect
685 failures. When set to <code>miimon</code>, will check for failures
686 by polling each interface's MII.
689 <column name="other_config" key="bond-miimon-interval"
690 type='{"type": "integer"}'>
691 The interval, in milliseconds, between successive attempts to poll
692 each interface's MII. Relevant only when <ref column="other_config"
693 key="bond-detect-mode"/> is <code>miimon</code>.
696 <column name="bond_updelay">
698 The number of milliseconds for which carrier must stay up on an
699 interface before the interface is considered to be up. Specify
700 <code>0</code> to enable the interface immediately.
704 This setting is honored only when at least one bonded interface is
705 already enabled. When no interfaces are enabled, then the first
706 bond interface to come up is enabled immediately.
710 <column name="bond_downdelay">
711 The number of milliseconds for which carrier must stay down on an
712 interface before the interface is considered to be down. Specify
713 <code>0</code> to disable the interface immediately.
717 <group title="LACP Configuration">
719 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
720 allows switches to automatically detect that they are connected by
721 multiple links and aggregate across those links. These settings
722 control LACP behavior.
726 Configures LACP on this port. LACP allows directly connected
727 switches to negotiate which links may be bonded. LACP may be enabled
728 on non-bonded ports for the benefit of any switches they may be
729 connected to. <code>active</code> ports are allowed to initiate LACP
730 negotiations. <code>passive</code> ports are allowed to participate
731 in LACP negotiations initiated by a remote switch, but not allowed to
732 initiate such negotiations themselves. Defaults to <code>off</code>
736 <column name="other_config" key="lacp-system-id">
737 The LACP system ID of this <ref table="Port"/>. The system ID of a
738 LACP bond is used to identify itself to its partners. Must be a
742 <column name="other_config" key="lacp-system-priority"
743 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
744 The LACP system priority of this <ref table="Port"/>. In LACP
745 negotiations, link status decisions are made by the system with the
746 numerically lower priority.
749 <column name="other_config" key="lacp-time">
751 The LACP timing which should be used on this <ref table="Port"/>.
752 Possible values are <code>fast</code>, <code>slow</code> and a
753 positive number of milliseconds. By default <code>slow</code> is
754 used. When configured to be <code>fast</code> LACP heartbeats are
755 requested at a rate of once per second causing connectivity
756 problems to be detected more quickly. In <code>slow</code> mode,
757 heartbeats are requested at a rate of once every 30 seconds.
761 Users may manually set a heartbeat transmission rate to increase
762 the fault detection speed further. When manually set, OVS expects
763 the partner switch to be configured with the same transmission
764 rate. Manually setting <code>lacp-time</code> to something other
765 than <code>fast</code> or <code>slow</code> is not supported by the
770 <column name="other_config" key="lacp-heartbeat"
771 type='{"type": "boolean"}'>
772 Treat LACP like a simple heartbeat protocol for link state
773 monitoring. Most features of the LACP protocol are disabled
774 when this mode is in use. The default if not specified is
778 <column name="other_config" key="bond-hash-basis"
779 type='{"type": "integer"}'>
780 An integer hashed along with flows when choosing output slaves. When
781 changed, all flows will be assigned different hash values possibly
782 causing slave selection decisions to change.
786 <group title="SLB Configuration">
788 These settings control behavior when a bond is in
789 <code>balance-slb</code> mode, regardless of whether the bond was
790 intentionally configured in SLB mode or it fell back to SLB mode
791 because LACP negotiation failed.
794 <column name="other_config" key="bond-rebalance-interval"
795 type='{"type": "integer", "minInteger": 1000, "maxInteger": 10000}'>
796 For an SLB bonded port, the number of milliseconds between successive
797 attempts to rebalance the bond, that is, to move source MACs and
798 their flows from one interface on the bond to another in an attempt
799 to keep usage of each interface roughly equal.
803 <column name="bond_fake_iface">
804 For a bonded port, whether to create a fake internal interface with the
805 name of the port. Use only for compatibility with legacy software that
810 <group title="Other Features">
812 Quality of Service configuration for this port.
816 The MAC address to use for this port for the purpose of choosing the
817 bridge's MAC address. This column does not necessarily reflect the
818 port's actual MAC address, nor will setting it change the port's actual
822 <column name="fake_bridge">
823 Does this port represent a sub-bridge for its tagged VLAN within the
824 Bridge? See ovs-vsctl(8) for more information.
827 <column name="external_ids" key="fake-bridge-id-*">
828 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
829 column) are defined by prefixing a <ref table="Bridge"/> <ref
830 table="Bridge" column="external_ids"/> key with
831 <code>fake-bridge-</code>,
832 e.g. <code>fake-bridge-xs-network-uuids</code>.
836 <group title="Common Columns">
837 The overall purpose of these columns is described under <code>Common
838 Columns</code> at the beginning of this document.
840 <column name="other_config"/>
841 <column name="external_ids"/>
845 <table name="Interface" title="One physical network device in a Port.">
846 An interface within a <ref table="Port"/>.
848 <group title="Core Features">
850 Interface name. Should be alphanumeric and no more than about 8 bytes
851 long. May be the same as the port name, for non-bonded ports. Must
852 otherwise be unique among the names of ports, interfaces, and bridges
857 <p>Ethernet address to set for this interface. If unset then the
858 default MAC address is used:</p>
860 <li>For the local interface, the default is the lowest-numbered MAC
861 address among the other bridge ports, either the value of the
862 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
863 if set, or its actual MAC (for bonded ports, the MAC of its slave
864 whose name is first in alphabetical order). Internal ports and
865 bridge ports that are used as port mirroring destinations (see the
866 <ref table="Mirror"/> table) are ignored.</li>
867 <li>For other internal interfaces, the default MAC is randomly
869 <li>External interfaces typically have a MAC address associated with
872 <p>Some interfaces may not have a software-controllable MAC
876 <column name="ofport">
877 <p>OpenFlow port number for this interface. Unlike most columns, this
878 column's value should be set only by Open vSwitch itself. Other
879 clients should set this column to an empty set (the default) when
880 creating an <ref table="Interface"/>.</p>
881 <p>Open vSwitch populates this column when the port number becomes
882 known. If the interface is successfully added,
883 <ref column="ofport"/> will be set to a number between 1 and 65535
884 (generally either in the range 1 to 65279, inclusive, or 65534, the
885 port number for the OpenFlow ``local port''). If the interface
886 cannot be added then Open vSwitch sets this column
891 <group title="System-Specific Details">
894 The interface type, one of:
898 <dt><code>system</code></dt>
899 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
900 Sometimes referred to as ``external interfaces'' since they are
901 generally connected to hardware external to that on which the Open
902 vSwitch is running. The empty string is a synonym for
903 <code>system</code>.</dd>
905 <dt><code>internal</code></dt>
906 <dd>A simulated network device that sends and receives traffic. An
907 internal interface whose <ref column="name"/> is the same as its
908 bridge's <ref table="Open_vSwitch" column="name"/> is called the
909 ``local interface.'' It does not make sense to bond an internal
910 interface, so the terms ``port'' and ``interface'' are often used
911 imprecisely for internal interfaces.</dd>
913 <dt><code>tap</code></dt>
914 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
916 <dt><code>gre</code></dt>
918 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
919 tunnel. See <ref group="Tunnel Options"/> for information on
920 configuring GRE tunnels.
923 <dt><code>ipsec_gre</code></dt>
925 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
929 <dt><code>capwap</code></dt>
931 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
932 5415). This allows interoperability with certain switches that do
933 not support GRE. Only the tunneling component of the protocol is
934 implemented. UDP ports 58881 and 58882 are used as the source and
935 destination ports respectively. CAPWAP is currently supported only
936 with the Linux kernel datapath with kernel version 2.6.26 or later.
939 <dt><code>patch</code></dt>
941 A pair of virtual devices that act as a patch cable.
944 <dt><code>null</code></dt>
945 <dd>An ignored interface.</dd>
950 <group title="Tunnel Options">
952 These options apply to interfaces with <ref column="type"/> of
953 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
957 Each tunnel must be uniquely identified by the combination of <ref
958 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
959 column="options" key="local_ip"/>, and <ref column="options"
960 key="in_key"/>. If two ports are defined that are the same except one
961 has an optional identifier and the other does not, the more specific
962 one is matched first. <ref column="options" key="in_key"/> is
963 considered more specific than <ref column="options" key="local_ip"/> if
964 a port defines one and another port defines the other.
967 <column name="options" key="remote_ip">
968 Required. The tunnel endpoint.
971 <column name="options" key="local_ip">
972 Optional. The destination IP that received packets must
973 match. Default is to match all addresses.
976 <column name="options" key="in_key">
977 <p>Optional. The key that received packets must contain, one of:</p>
981 <code>0</code>. The tunnel receives packets with no key or with a
982 key of 0. This is equivalent to specifying no <ref column="options"
983 key="in_key"/> at all.
986 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
987 tunnel receives only packets with the specified key.
990 The word <code>flow</code>. The tunnel accepts packets with any
991 key. The key will be placed in the <code>tun_id</code> field for
992 matching in the flow table. The <code>ovs-ofctl</code> manual page
993 contains additional information about matching fields in OpenFlow
1002 <column name="options" key="out_key">
1003 <p>Optional. The key to be set on outgoing packets, one of:</p>
1007 <code>0</code>. Packets sent through the tunnel will have no key.
1008 This is equivalent to specifying no <ref column="options"
1009 key="out_key"/> at all.
1012 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1013 sent through the tunnel will have the specified key.
1016 The word <code>flow</code>. Packets sent through the tunnel will
1017 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1018 vendor extension (0 is used in the absence of an action). The
1019 <code>ovs-ofctl</code> manual page contains additional information
1020 about the Nicira OpenFlow vendor extensions.
1025 <column name="options" key="key">
1026 Optional. Shorthand to set <code>in_key</code> and
1027 <code>out_key</code> at the same time.
1030 <column name="options" key="tos">
1031 Optional. The value of the ToS bits to be set on the encapsulating
1032 packet. It may also be the word <code>inherit</code>, in which case
1033 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1034 (otherwise it will be 0). The ECN fields are always inherited.
1038 <column name="options" key="ttl">
1039 Optional. The TTL to be set on the encapsulating packet. It may also
1040 be the word <code>inherit</code>, in which case the TTL will be copied
1041 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1042 system default, typically 64). Default is the system default TTL.
1045 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1046 Optional. If enabled, the Don't Fragment bit will be copied from the
1047 inner IP headers (those of the encapsulated traffic) to the outer
1048 (tunnel) headers. Default is disabled; set to <code>true</code> to
1052 <column name="options" key="df_default"
1053 type='{"type": "boolean"}'>
1054 Optional. If enabled, the Don't Fragment bit will be set by default on
1055 tunnel headers if the <code>df_inherit</code> option is not set, or if
1056 the encapsulated packet is not IP. Default is enabled; set to
1057 <code>false</code> to disable.
1060 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1061 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1062 Destination Unreachable - Fragmentation Needed'' messages will be
1063 generated for IPv4 packets with the DF bit set and IPv6 packets above
1064 the minimum MTU if the packet size exceeds the path MTU minus the size
1065 of the tunnel headers. Note that this option causes behavior that is
1066 typically reserved for routers and therefore is not entirely in
1067 compliance with the IEEE 802.1D specification for bridges. Default is
1068 enabled; set to <code>false</code> to disable.
1071 <group title="Tunnel Options: gre only">
1073 Only <code>gre</code> interfaces support these options.
1076 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1077 Enable caching of tunnel headers and the output path. This can lead
1078 to a significant performance increase without changing behavior. In
1079 general it should not be necessary to adjust this setting. However,
1080 the caching can bypass certain components of the IP stack (such as
1081 <code>iptables</code>) and it may be useful to disable it if these
1082 features are required or as a debugging measure. Default is enabled,
1083 set to <code>false</code> to disable.
1087 <group title="Tunnel Options: gre and ipsec_gre only">
1089 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1093 <column name="options" key="csum" type='{"type": "boolean"}'>
1095 Optional. Compute GRE checksums on outgoing packets. Default is
1096 disabled, set to <code>true</code> to enable. Checksums present on
1097 incoming packets will be validated regardless of this setting.
1101 GRE checksums impose a significant performance penalty because they
1102 cover the entire packet. The encapsulated L3, L4, and L7 packet
1103 contents typically have their own checksums, so this additional
1104 checksum only adds value for the GRE and encapsulated L2 headers.
1108 This option is supported for <code>ipsec_gre</code>, but not useful
1109 because GRE checksums are weaker than, and redundant with, IPsec
1110 payload authentication.
1115 <group title="Tunnel Options: ipsec_gre only">
1117 Only <code>ipsec_gre</code> interfaces support these options.
1120 <column name="options" key="peer_cert">
1121 Required for certificate authentication. A string containing the
1122 peer's certificate in PEM format. Additionally the host's
1123 certificate must be specified with the <code>certificate</code>
1127 <column name="options" key="certificate">
1128 Required for certificate authentication. The name of a PEM file
1129 containing a certificate that will be presented to the peer during
1133 <column name="options" key="private_key">
1134 Optional for certificate authentication. The name of a PEM file
1135 containing the private key associated with <code>certificate</code>.
1136 If <code>certificate</code> contains the private key, this option may
1140 <column name="options" key="psk">
1141 Required for pre-shared key authentication. Specifies a pre-shared
1142 key for authentication that must be identical on both sides of the
1148 <group title="Patch Options">
1150 Only <code>patch</code> interfaces support these options.
1153 <column name="options" key="peer">
1154 The <ref column="name"/> of the <ref table="Interface"/> for the other
1155 side of the patch. The named <ref table="Interface"/>'s own
1156 <code>peer</code> option must specify this <ref table="Interface"/>'s
1157 name. That is, the two patch interfaces must have reversed <ref
1158 column="name"/> and <code>peer</code> values.
1162 <group title="Interface Status">
1164 Status information about interfaces attached to bridges, updated every
1165 5 seconds. Not all interfaces have all of these properties; virtual
1166 interfaces don't have a link speed, for example. Non-applicable
1167 columns will have empty values.
1169 <column name="admin_state">
1171 The administrative state of the physical network link.
1175 <column name="link_state">
1177 The observed state of the physical network link. This is ordinarily
1178 the link's carrier status. If the interface's <ref table="Port"/> is
1179 a bond configured for miimon monitoring, it is instead the network
1180 link's miimon status.
1184 <column name="link_resets">
1186 The number of times Open vSwitch has observed the
1187 <ref column="link_state"/> of this <ref table="Interface"/> change.
1191 <column name="link_speed">
1193 The negotiated speed of the physical network link.
1194 Valid values are positive integers greater than 0.
1198 <column name="duplex">
1200 The duplex mode of the physical network link.
1206 The MTU (maximum transmission unit); i.e. the largest
1207 amount of data that can fit into a single Ethernet frame.
1208 The standard Ethernet MTU is 1500 bytes. Some physical media
1209 and many kinds of virtual interfaces can be configured with
1213 This column will be empty for an interface that does not
1214 have an MTU as, for example, some kinds of tunnels do not.
1218 <column name="lacp_current">
1219 Boolean value indicating LACP status for this interface. If true, this
1220 interface has current LACP information about its LACP partner. This
1221 information may be used to monitor the health of interfaces in a LACP
1222 enabled port. This column will be empty if LACP is not enabled.
1225 <column name="status">
1226 Key-value pairs that report port status. Supported status values are
1227 <ref column="type"/>-dependent; some interfaces may not have a valid
1228 <ref column="status" key="driver_name"/>, for example.
1231 <column name="status" key="driver_name">
1232 The name of the device driver controlling the network adapter.
1235 <column name="status" key="driver_version">
1236 The version string of the device driver controlling the network
1240 <column name="status" key="firmware_version">
1241 The version string of the network adapter's firmware, if available.
1244 <column name="status" key="source_ip">
1245 The source IP address used for an IPv4 tunnel end-point, such as
1246 <code>gre</code> or <code>capwap</code>.
1249 <column name="status" key="tunnel_egress_iface">
1250 Egress interface for tunnels. Currently only relevant for GRE and
1251 CAPWAP tunnels. On Linux systems, this column will show the name of
1252 the interface which is responsible for routing traffic destined for the
1253 configured <ref column="options" key="remote_ip"/>. This could be an
1254 internal interface such as a bridge port.
1257 <column name="status" key="tunnel_egress_iface_carrier"
1258 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1259 Whether carrier is detected on <ref column="status"
1260 key="tunnel_egress_iface"/>.
1264 <group title="Statistics">
1266 Key-value pairs that report interface statistics. The current
1267 implementation updates these counters periodically. Future
1268 implementations may update them when an interface is created, when they
1269 are queried (e.g. using an OVSDB <code>select</code> operation), and
1270 just before an interface is deleted due to virtual interface hot-unplug
1271 or VM shutdown, and perhaps at other times, but not on any regular
1275 These are the same statistics reported by OpenFlow in its <code>struct
1276 ofp_port_stats</code> structure. If an interface does not support a
1277 given statistic, then that pair is omitted.
1279 <group title="Statistics: Successful transmit and receive counters">
1280 <column name="statistics" key="rx_packets">
1281 Number of received packets.
1283 <column name="statistics" key="rx_bytes">
1284 Number of received bytes.
1286 <column name="statistics" key="tx_packets">
1287 Number of transmitted packets.
1289 <column name="statistics" key="tx_bytes">
1290 Number of transmitted bytes.
1293 <group title="Statistics: Receive errors">
1294 <column name="statistics" key="rx_dropped">
1295 Number of packets dropped by RX.
1297 <column name="statistics" key="rx_frame_err">
1298 Number of frame alignment errors.
1300 <column name="statistics" key="rx_over_err">
1301 Number of packets with RX overrun.
1303 <column name="statistics" key="rx_crc_err">
1304 Number of CRC errors.
1306 <column name="statistics" key="rx_errors">
1307 Total number of receive errors, greater than or equal to the sum of
1311 <group title="Statistics: Transmit errors">
1312 <column name="statistics" key="tx_dropped">
1313 Number of packets dropped by TX.
1315 <column name="statistics" key="collisions">
1316 Number of collisions.
1318 <column name="statistics" key="tx_errors">
1319 Total number of transmit errors, greater than or equal to the sum of
1325 <group title="Ingress Policing">
1327 These settings control ingress policing for packets received on this
1328 interface. On a physical interface, this limits the rate at which
1329 traffic is allowed into the system from the outside; on a virtual
1330 interface (one connected to a virtual machine), this limits the rate at
1331 which the VM is able to transmit.
1334 Policing is a simple form of quality-of-service that simply drops
1335 packets received in excess of the configured rate. Due to its
1336 simplicity, policing is usually less accurate and less effective than
1337 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1338 table="Queue"/> tables).
1341 Policing is currently implemented only on Linux. The Linux
1342 implementation uses a simple ``token bucket'' approach:
1346 The size of the bucket corresponds to <ref
1347 column="ingress_policing_burst"/>. Initially the bucket is full.
1350 Whenever a packet is received, its size (converted to tokens) is
1351 compared to the number of tokens currently in the bucket. If the
1352 required number of tokens are available, they are removed and the
1353 packet is forwarded. Otherwise, the packet is dropped.
1356 Whenever it is not full, the bucket is refilled with tokens at the
1357 rate specified by <ref column="ingress_policing_rate"/>.
1361 Policing interacts badly with some network protocols, and especially
1362 with fragmented IP packets. Suppose that there is enough network
1363 activity to keep the bucket nearly empty all the time. Then this token
1364 bucket algorithm will forward a single packet every so often, with the
1365 period depending on packet size and on the configured rate. All of the
1366 fragments of an IP packets are normally transmitted back-to-back, as a
1367 group. In such a situation, therefore, only one of these fragments
1368 will be forwarded and the rest will be dropped. IP does not provide
1369 any way for the intended recipient to ask for only the remaining
1370 fragments. In such a case there are two likely possibilities for what
1371 will happen next: either all of the fragments will eventually be
1372 retransmitted (as TCP will do), in which case the same problem will
1373 recur, or the sender will not realize that its packet has been dropped
1374 and data will simply be lost (as some UDP-based protocols will do).
1375 Either way, it is possible that no forward progress will ever occur.
1377 <column name="ingress_policing_rate">
1379 Maximum rate for data received on this interface, in kbps. Data
1380 received faster than this rate is dropped. Set to <code>0</code>
1381 (the default) to disable policing.
1385 <column name="ingress_policing_burst">
1386 <p>Maximum burst size for data received on this interface, in kb. The
1387 default burst size if set to <code>0</code> is 1000 kb. This value
1388 has no effect if <ref column="ingress_policing_rate"/>
1389 is <code>0</code>.</p>
1391 Specifying a larger burst size lets the algorithm be more forgiving,
1392 which is important for protocols like TCP that react severely to
1393 dropped packets. The burst size should be at least the size of the
1394 interface's MTU. Specifying a value that is numerically at least as
1395 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1396 closer to achieving the full rate.
1401 <group title="Connectivity Fault Management">
1403 802.1ag Connectivity Fault Management (CFM) allows a group of
1404 Maintenance Points (MPs) called a Maintenance Association (MA) to
1405 detect connectivity problems with each other. MPs within a MA should
1406 have complete and exclusive interconnectivity. This is verified by
1407 occasionally broadcasting Continuity Check Messages (CCMs) at a
1408 configurable transmission interval.
1412 According to the 802.1ag specification, each Maintenance Point should
1413 be configured out-of-band with a list of Remote Maintenance Points it
1414 should have connectivity to. Open vSwitch differs from the
1415 specification in this area. It simply assumes the link is faulted if
1416 no Remote Maintenance Points are reachable, and considers it not
1420 <column name="cfm_mpid">
1421 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1422 a Maintenance Association. The MPID is used to identify this endpoint
1423 to other Maintenance Points in the MA. Each end of a link being
1424 monitored should have a different MPID. Must be configured to enable
1425 CFM on this <ref table="Interface"/>.
1428 <column name="cfm_fault">
1430 Indicates a connectivity fault triggered by an inability to receive
1431 heartbeats from any remote endpoint. When a fault is triggered on
1432 <ref table="Interface"/>s participating in bonds, they will be
1436 Faults can be triggered for several reasons. Most importantly they
1437 are triggered when no CCMs are received for a period of 3.5 times the
1438 transmission interval. Faults are also triggered when any CCMs
1439 indicate that a Remote Maintenance Point is not receiving CCMs but
1440 able to send them. Finally, a fault is triggered if a CCM is
1441 received which indicates unexpected configuration. Notably, this
1442 case arises when a CCM is received which advertises the local MPID.
1446 <column name="cfm_remote_mpids">
1447 When CFM is properly configured, Open vSwitch will occasionally
1448 receive CCM broadcasts. These broadcasts contain the MPID of the
1449 sending Maintenance Point. The list of MPIDs from which this
1450 <ref table="Interface"/> is receiving broadcasts from is regularly
1451 collected and written to this column.
1454 <column name="other_config" key="cfm_interval"
1455 type='{"type": "integer"}'>
1456 The interval, in milliseconds, between transmissions of CFM heartbeats.
1457 Three missed heartbeat receptions indicate a connectivity fault.
1461 <column name="other_config" key="cfm_extended"
1462 type='{"type": "boolean"}'>
1463 When <code>true</code>, the CFM module operates in extended mode. This
1464 causes it to use a nonstandard destination address to avoid conflicting
1465 with compliant implementations which may be running concurrently on the
1466 network. Furthermore, extended mode increases the accuracy of the
1467 <code>cfm_interval</code> configuration parameter by breaking wire
1468 compatibility with 802.1ag compliant implementations. Defaults to
1471 <column name="other_config" key="cfm_opstate"
1472 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1473 When <code>down</code>, the CFM module marks all CCMs it generates as
1474 operationally down without triggering a fault. This allows remote
1475 maintenance points to choose not to forward traffic to the
1476 <ref table="Interface"/> on which this CFM module is running.
1477 Currently, in Open vSwitch, the opdown bit of CCMs affects
1478 <ref table="Interface"/>s participating in bonds, and the bundle
1479 OpenFlow action. This setting is ignored when CFM is not in extended
1480 mode. Defaults to <code>up</code>.
1484 <group title="Bonding Configuration">
1485 <column name="other_config" key="bond-stable-id"
1486 type='{"type": "integer", "minInteger": 1}'>
1487 Used in <code>stable</code> bond mode to make slave
1488 selection decisions. Allocating <ref column="other_config"
1489 key="bond-stable-id"/> values consistently across interfaces
1490 participating in a bond will guarantee consistent slave selection
1491 decisions across <code>ovs-vswitchd</code> instances when using
1492 <code>stable</code> bonding mode.
1495 <column name="other_config" key="lacp-port-id"
1496 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1497 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1498 used in LACP negotiations to identify individual ports
1499 participating in a bond.
1502 <column name="other_config" key="lacp-port-priority"
1503 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1504 The LACP port priority of this <ref table="Interface"/>. In LACP
1505 negotiations <ref table="Interface"/>s with numerically lower
1506 priorities are preferred for aggregation.
1509 <column name="other_config" key="lacp-aggregation-key"
1510 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1511 The LACP aggregation key of this <ref table="Interface"/>. <ref
1512 table="Interface"/>s with different aggregation keys may not be active
1513 within a given <ref table="Port"/> at the same time.
1517 <group title="Virtual Machine Identifiers">
1519 These key-value pairs specifically apply to an interface that
1520 represents a virtual Ethernet interface connected to a virtual
1521 machine. These key-value pairs should not be present for other types
1522 of interfaces. Keys whose names end in <code>-uuid</code> have
1523 values that uniquely identify the entity in question. For a Citrix
1524 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1525 Other hypervisors may use other formats.
1528 <column name="external_ids" key="attached-mac">
1529 The MAC address programmed into the ``virtual hardware'' for this
1530 interface, in the form
1531 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1532 For Citrix XenServer, this is the value of the <code>MAC</code> field
1533 in the VIF record for this interface.
1536 <column name="external_ids" key="iface-id">
1537 A system-unique identifier for the interface. On XenServer, this will
1538 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1541 <column name="external_ids" key="xs-vif-uuid">
1542 The virtual interface associated with this interface.
1545 <column name="external_ids" key="xs-network-uuid">
1546 The virtual network to which this interface is attached.
1549 <column name="external_ids" key="xs-vm-uuid">
1550 The VM to which this interface belongs.
1554 <group title="Common Columns">
1555 The overall purpose of these columns is described under <code>Common
1556 Columns</code> at the beginning of this document.
1558 <column name="other_config"/>
1559 <column name="external_ids"/>
1563 <table name="QoS" title="Quality of Service configuration">
1564 <p>Quality of Service (QoS) configuration for each Port that
1567 <column name="type">
1568 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1569 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1570 identifies the types that a switch actually supports. The currently
1571 defined types are listed below:</p>
1573 <dt><code>linux-htb</code></dt>
1575 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1576 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1577 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1578 for information on how this classifier works and how to configure it.
1582 <dt><code>linux-hfsc</code></dt>
1584 Linux "Hierarchical Fair Service Curve" classifier.
1585 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1586 information on how this classifier works.
1591 <column name="queues">
1592 <p>A map from queue numbers to <ref table="Queue"/> records. The
1593 supported range of queue numbers depend on <ref column="type"/>. The
1594 queue numbers are the same as the <code>queue_id</code> used in
1595 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1596 structures. Queue 0 is used by OpenFlow output actions that do not
1597 specify a specific queue.</p>
1600 <group title="Configuration for linux-htb and linux-hfsc">
1602 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1603 the following key-value pair:
1606 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
1607 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
1608 specified, for physical interfaces, the default is the link rate. For
1609 other interfaces or if the link rate cannot be determined, the default
1610 is currently 100 Mbps.
1614 <group title="Common Columns">
1615 The overall purpose of these columns is described under <code>Common
1616 Columns</code> at the beginning of this document.
1618 <column name="other_config"/>
1619 <column name="external_ids"/>
1623 <table name="Queue" title="QoS output queue.">
1624 <p>A configuration for a port output queue, used in configuring Quality of
1625 Service (QoS) features. May be referenced by <ref column="queues"
1626 table="QoS"/> column in <ref table="QoS"/> table.</p>
1628 <group title="Configuration for min-rate QoS">
1630 These key-value pairs are defined for <ref table="QoS"/> <ref
1631 table="QoS" column="type"/> of <code>min-rate</code>.
1634 <column name="other_config" key="min-rate"
1635 type='{"type": "integer", "minInteger": 12000}'>
1636 Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
1637 1500 bytes/s (12,000 bit/s).
1641 <group title="Configuration for linux-htb QoS">
1643 These key-value pairs are defined for <ref table="QoS"/> <ref
1644 table="QoS" column="type"/> of <code>linux-htb</code>.
1647 <column name="other_config" key="min-rate"
1648 type='{"type": "integer", "minInteger": 1}'>
1649 Minimum guaranteed bandwidth, in bit/s.
1652 <column name="other_config" key="max-rate"
1653 type='{"type": "integer", "minInteger": 1}'>
1654 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1655 queue's rate will not be allowed to exceed the specified value, even
1656 if excess bandwidth is available. If unspecified, defaults to no
1660 <column name="other_config" key="burst"
1661 type='{"type": "integer", "minInteger": 1}'>
1662 Burst size, in bits. This is the maximum amount of ``credits'' that a
1663 queue can accumulate while it is idle. Optional. Details of the
1664 <code>linux-htb</code> implementation require a minimum burst size, so
1665 a too-small <code>burst</code> will be silently ignored.
1668 <column name="other_config" key="priority"
1669 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
1670 A queue with a smaller <code>priority</code> will receive all the
1671 excess bandwidth that it can use before a queue with a larger value
1672 receives any. Specific priority values are unimportant; only relative
1673 ordering matters. Defaults to 0 if unspecified.
1677 <group title="Configuration for linux-hfsc QoS">
1679 These key-value pairs are defined for <ref table="QoS"/> <ref
1680 table="QoS" column="type"/> of <code>linux-hfsc</code>.
1683 <column name="other_config" key="min-rate"
1684 type='{"type": "integer", "minInteger": 1}'>
1685 Minimum guaranteed bandwidth, in bit/s.
1688 <column name="other_config" key="max-rate"
1689 type='{"type": "integer", "minInteger": 1}'>
1690 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1691 queue's rate will not be allowed to exceed the specified value, even if
1692 excess bandwidth is available. If unspecified, defaults to no
1697 <group title="Common Columns">
1698 The overall purpose of these columns is described under <code>Common
1699 Columns</code> at the beginning of this document.
1701 <column name="other_config"/>
1702 <column name="external_ids"/>
1706 <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
1707 <p>A port mirror within a <ref table="Bridge"/>.</p>
1708 <p>A port mirror configures a bridge to send selected frames to special
1709 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1710 traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
1711 the mirrored traffic is sent.</p>
1713 <column name="name">
1714 Arbitrary identifier for the <ref table="Mirror"/>.
1717 <group title="Selecting Packets for Mirroring">
1719 To be selected for mirroring, a given packet must enter or leave the
1720 bridge through a selected port and it must also be in one of the
1724 <column name="select_all">
1725 If true, every packet arriving or departing on any port is
1726 selected for mirroring.
1729 <column name="select_dst_port">
1730 Ports on which departing packets are selected for mirroring.
1733 <column name="select_src_port">
1734 Ports on which arriving packets are selected for mirroring.
1737 <column name="select_vlan">
1738 VLANs on which packets are selected for mirroring. An empty set
1739 selects packets on all VLANs.
1743 <group title="Mirroring Destination Configuration">
1745 These columns are mutually exclusive. Exactly one of them must be
1749 <column name="output_port">
1750 <p>Output port for selected packets, if nonempty.</p>
1751 <p>Specifying a port for mirror output reserves that port exclusively
1752 for mirroring. No frames other than those selected for mirroring
1753 will be forwarded to the port, and any frames received on the port
1754 will be discarded.</p>
1756 The output port may be any kind of port supported by Open vSwitch.
1757 It may be, for example, a physical port (sometimes called SPAN), or a
1758 GRE tunnel (sometimes called ERSPAN).
1762 <column name="output_vlan">
1763 <p>Output VLAN for selected packets, if nonempty.</p>
1764 <p>The frames will be sent out all ports that trunk
1765 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1766 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1767 trunk port, the frame's VLAN tag will be set to
1768 <ref column="output_vlan"/>, replacing any existing tag; when it is
1769 sent out an implicit VLAN port, the frame will not be tagged. This
1770 type of mirroring is sometimes called RSPAN.</p>
1772 The following destination MAC addresses will not be mirrored to a
1773 VLAN to avoid confusing switches that interpret the protocols that
1777 <dt><code>01:80:c2:00:00:00</code></dt>
1778 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1780 <dt><code>01:80:c2:00:00:01</code></dt>
1781 <dd>IEEE Pause frame.</dd>
1783 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1784 <dd>Other reserved protocols.</dd>
1786 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1788 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1789 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1793 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1794 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1796 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1797 <dd>Cisco STP Uplink Fast.</dd>
1799 <dt><code>01:00:0c:00:00:00</code></dt>
1800 <dd>Cisco Inter Switch Link.</dd>
1802 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1803 contains unmanaged switches. Consider an unmanaged physical switch
1804 with two ports: port 1, connected to an end host, and port 2,
1805 connected to an Open vSwitch configured to mirror received packets
1806 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1807 port 1 that the physical switch forwards to port 2. The Open vSwitch
1808 forwards this packet to its destination and then reflects it back on
1809 port 2 in VLAN 123. This reflected packet causes the unmanaged
1810 physical switch to replace the MAC learning table entry, which
1811 correctly pointed to port 1, with one that incorrectly points to port
1812 2. Afterward, the physical switch will direct packets destined for
1813 the end host to the Open vSwitch on port 2, instead of to the end
1814 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1815 desired in this scenario, then the physical switch must be replaced
1816 by one that learns Ethernet addresses on a per-VLAN basis. In
1817 addition, learning should be disabled on the VLAN containing mirrored
1818 traffic. If this is not done then intermediate switches will learn
1819 the MAC address of each end host from the mirrored traffic. If
1820 packets being sent to that end host are also mirrored, then they will
1821 be dropped since the switch will attempt to send them out the input
1822 port. Disabling learning for the VLAN will cause the switch to
1823 correctly send the packet out all ports configured for that VLAN. If
1824 Open vSwitch is being used as an intermediate switch, learning can be
1825 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1826 in the appropriate <ref table="Bridge"/> table or tables.</p>
1828 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
1829 VLAN and should generally be preferred.
1834 <group title="Common Columns">
1835 The overall purpose of these columns is described under <code>Common
1836 Columns</code> at the beginning of this document.
1838 <column name="external_ids"/>
1842 <table name="Controller" title="OpenFlow controller configuration.">
1843 <p>An OpenFlow controller.</p>
1846 Open vSwitch supports two kinds of OpenFlow controllers:
1850 <dt>Primary controllers</dt>
1853 This is the kind of controller envisioned by the OpenFlow 1.0
1854 specification. Usually, a primary controller implements a network
1855 policy by taking charge of the switch's flow table.
1859 Open vSwitch initiates and maintains persistent connections to
1860 primary controllers, retrying the connection each time it fails or
1861 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1862 <ref table="Bridge"/> table applies to primary controllers.
1866 Open vSwitch permits a bridge to have any number of primary
1867 controllers. When multiple controllers are configured, Open
1868 vSwitch connects to all of them simultaneously. Because
1869 OpenFlow 1.0 does not specify how multiple controllers
1870 coordinate in interacting with a single switch, more than
1871 one primary controller should be specified only if the
1872 controllers are themselves designed to coordinate with each
1873 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1874 vendor extension may be useful for this.)
1877 <dt>Service controllers</dt>
1880 These kinds of OpenFlow controller connections are intended for
1881 occasional support and maintenance use, e.g. with
1882 <code>ovs-ofctl</code>. Usually a service controller connects only
1883 briefly to inspect or modify some of a switch's state.
1887 Open vSwitch listens for incoming connections from service
1888 controllers. The service controllers initiate and, if necessary,
1889 maintain the connections from their end. The <ref table="Bridge"
1890 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1891 not apply to service controllers.
1895 Open vSwitch supports configuring any number of service controllers.
1901 The <ref column="target"/> determines the type of controller.
1904 <group title="Core Features">
1905 <column name="target">
1906 <p>Connection method for controller.</p>
1908 The following connection methods are currently supported for primary
1912 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1914 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1915 the given <var>ip</var>, which must be expressed as an IP address
1916 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1917 column in the <ref table="Open_vSwitch"/> table must point to a
1918 valid SSL configuration when this form is used.</p>
1919 <p>SSL support is an optional feature that is not always built as
1920 part of Open vSwitch.</p>
1922 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1923 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1924 the given <var>ip</var>, which must be expressed as an IP address
1925 (not a DNS name).</dd>
1928 The following connection methods are currently supported for service
1932 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1935 Listens for SSL connections on the specified TCP <var>port</var>
1936 (default: 6633). If <var>ip</var>, which must be expressed as an
1937 IP address (not a DNS name), is specified, then connections are
1938 restricted to the specified local IP address.
1941 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1942 table="Open_vSwitch"/> table must point to a valid SSL
1943 configuration when this form is used.
1945 <p>SSL support is an optional feature that is not always built as
1946 part of Open vSwitch.</p>
1948 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1950 Listens for connections on the specified TCP <var>port</var>
1951 (default: 6633). If <var>ip</var>, which must be expressed as an
1952 IP address (not a DNS name), is specified, then connections are
1953 restricted to the specified local IP address.
1956 <p>When multiple controllers are configured for a single bridge, the
1957 <ref column="target"/> values must be unique. Duplicate
1958 <ref column="target"/> values yield unspecified results.</p>
1961 <column name="connection_mode">
1962 <p>If it is specified, this setting must be one of the following
1963 strings that describes how Open vSwitch contacts this OpenFlow
1964 controller over the network:</p>
1967 <dt><code>in-band</code></dt>
1968 <dd>In this mode, this controller's OpenFlow traffic travels over the
1969 bridge associated with the controller. With this setting, Open
1970 vSwitch allows traffic to and from the controller regardless of the
1971 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1972 would never be able to connect to the controller, because it did
1973 not have a flow to enable it.) This is the most common connection
1974 mode because it is not necessary to maintain two independent
1976 <dt><code>out-of-band</code></dt>
1977 <dd>In this mode, OpenFlow traffic uses a control network separate
1978 from the bridge associated with this controller, that is, the
1979 bridge does not use any of its own network devices to communicate
1980 with the controller. The control network must be configured
1981 separately, before or after <code>ovs-vswitchd</code> is started.
1985 <p>If not specified, the default is implementation-specific.</p>
1989 <group title="Controller Failure Detection and Handling">
1990 <column name="max_backoff">
1991 Maximum number of milliseconds to wait between connection attempts.
1992 Default is implementation-specific.
1995 <column name="inactivity_probe">
1996 Maximum number of milliseconds of idle time on connection to
1997 controller before sending an inactivity probe message. If Open
1998 vSwitch does not communicate with the controller for the specified
1999 number of seconds, it will send a probe. If a response is not
2000 received for the same additional amount of time, Open vSwitch
2001 assumes the connection has been broken and attempts to reconnect.
2002 Default is implementation-specific. A value of 0 disables
2007 <group title="OpenFlow Rate Limiting">
2008 <column name="controller_rate_limit">
2009 <p>The maximum rate at which packets in unknown flows will be
2010 forwarded to the OpenFlow controller, in packets per second. This
2011 feature prevents a single bridge from overwhelming the controller.
2012 If not specified, the default is implementation-specific.</p>
2013 <p>In addition, when a high rate triggers rate-limiting, Open
2014 vSwitch queues controller packets for each port and transmits
2015 them to the controller at the configured rate. The number of
2016 queued packets is limited by
2017 the <ref column="controller_burst_limit"/> value. The packet
2018 queue is shared fairly among the ports on a bridge.</p><p>Open
2019 vSwitch maintains two such packet rate-limiters per bridge.
2020 One of these applies to packets sent up to the controller
2021 because they do not correspond to any flow. The other applies
2022 to packets sent up to the controller by request through flow
2023 actions. When both rate-limiters are filled with packets, the
2024 actual rate that packets are sent to the controller is up to
2025 twice the specified rate.</p>
2028 <column name="controller_burst_limit">
2029 In conjunction with <ref column="controller_rate_limit"/>,
2030 the maximum number of unused packet credits that the bridge will
2031 allow to accumulate, in packets. If not specified, the default
2032 is implementation-specific.
2036 <group title="Additional In-Band Configuration">
2037 <p>These values are considered only in in-band control mode (see
2038 <ref column="connection_mode"/>).</p>
2040 <p>When multiple controllers are configured on a single bridge, there
2041 should be only one set of unique values in these columns. If different
2042 values are set for these columns in different controllers, the effect
2045 <column name="local_ip">
2046 The IP address to configure on the local port,
2047 e.g. <code>192.168.0.123</code>. If this value is unset, then
2048 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2052 <column name="local_netmask">
2053 The IP netmask to configure on the local port,
2054 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2055 but this value is unset, then the default is chosen based on whether
2056 the IP address is class A, B, or C.
2059 <column name="local_gateway">
2060 The IP address of the gateway to configure on the local port, as a
2061 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2062 this network has no gateway.
2066 <group title="Controller Status">
2067 <column name="is_connected">
2068 <code>true</code> if currently connected to this controller,
2069 <code>false</code> otherwise.
2073 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2074 <p>The level of authority this controller has on the associated
2075 bridge. Possible values are:</p>
2077 <dt><code>other</code></dt>
2078 <dd>Allows the controller access to all OpenFlow features.</dd>
2079 <dt><code>master</code></dt>
2080 <dd>Equivalent to <code>other</code>, except that there may be at
2081 most one master controller at a time. When a controller configures
2082 itself as <code>master</code>, any existing master is demoted to
2083 the <code>slave</code>role.</dd>
2084 <dt><code>slave</code></dt>
2085 <dd>Allows the controller read-only access to OpenFlow features.
2086 Attempts to modify the flow table will be rejected with an
2087 error. Slave controllers do not receive OFPT_PACKET_IN or
2088 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2093 <column name="status" key="last_error">
2094 A human-readable description of the last error on the connection
2095 to the controller; i.e. <code>strerror(errno)</code>. This key
2096 will exist only if an error has occurred.
2099 <column name="status" key="state"
2100 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2102 The state of the connection to the controller:
2105 <dt><code>VOID</code></dt>
2106 <dd>Connection is disabled.</dd>
2108 <dt><code>BACKOFF</code></dt>
2109 <dd>Attempting to reconnect at an increasing period.</dd>
2111 <dt><code>CONNECTING</code></dt>
2112 <dd>Attempting to connect.</dd>
2114 <dt><code>ACTIVE</code></dt>
2115 <dd>Connected, remote host responsive.</dd>
2117 <dt><code>IDLE</code></dt>
2118 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2121 These values may change in the future. They are provided only for
2126 <column name="status" key="sec_since_connect"
2127 type='{"type": "integer", "minInteger": 0}'>
2128 The amount of time since this controller last successfully connected to
2129 the switch (in seconds). Value is empty if controller has never
2130 successfully connected.
2133 <column name="status" key="sec_since_disconnect"
2134 type='{"type": "integer", "minInteger": 1}'>
2135 The amount of time since this controller last disconnected from
2136 the switch (in seconds). Value is empty if controller has never
2141 <group title="Common Columns">
2142 The overall purpose of these columns is described under <code>Common
2143 Columns</code> at the beginning of this document.
2145 <column name="external_ids"/>
2149 <table name="Manager" title="OVSDB management connection.">
2151 Configuration for a database connection to an Open vSwitch database
2156 This table primarily configures the Open vSwitch database
2157 (<code>ovsdb-server</code>), not the Open vSwitch switch
2158 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2159 what connections should be treated as in-band.
2163 The Open vSwitch database server can initiate and maintain active
2164 connections to remote clients. It can also listen for database
2168 <group title="Core Features">
2169 <column name="target">
2170 <p>Connection method for managers.</p>
2172 The following connection methods are currently supported:
2175 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2178 The specified SSL <var>port</var> (default: 6632) on the host at
2179 the given <var>ip</var>, which must be expressed as an IP address
2180 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2181 column in the <ref table="Open_vSwitch"/> table must point to a
2182 valid SSL configuration when this form is used.
2185 SSL support is an optional feature that is not always built as
2186 part of Open vSwitch.
2190 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2192 The specified TCP <var>port</var> (default: 6632) on the host at
2193 the given <var>ip</var>, which must be expressed as an IP address
2196 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2199 Listens for SSL connections on the specified TCP <var>port</var>
2200 (default: 6632). If <var>ip</var>, which must be expressed as an
2201 IP address (not a DNS name), is specified, then connections are
2202 restricted to the specified local IP address.
2205 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2206 table="Open_vSwitch"/> table must point to a valid SSL
2207 configuration when this form is used.
2210 SSL support is an optional feature that is not always built as
2211 part of Open vSwitch.
2214 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2216 Listens for connections on the specified TCP <var>port</var>
2217 (default: 6632). If <var>ip</var>, which must be expressed as an
2218 IP address (not a DNS name), is specified, then connections are
2219 restricted to the specified local IP address.
2222 <p>When multiple managers are configured, the <ref column="target"/>
2223 values must be unique. Duplicate <ref column="target"/> values yield
2224 unspecified results.</p>
2227 <column name="connection_mode">
2229 If it is specified, this setting must be one of the following strings
2230 that describes how Open vSwitch contacts this OVSDB client over the
2235 <dt><code>in-band</code></dt>
2237 In this mode, this connection's traffic travels over a bridge
2238 managed by Open vSwitch. With this setting, Open vSwitch allows
2239 traffic to and from the client regardless of the contents of the
2240 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2241 to connect to the client, because it did not have a flow to enable
2242 it.) This is the most common connection mode because it is not
2243 necessary to maintain two independent networks.
2245 <dt><code>out-of-band</code></dt>
2247 In this mode, the client's traffic uses a control network separate
2248 from that managed by Open vSwitch, that is, Open vSwitch does not
2249 use any of its own network devices to communicate with the client.
2250 The control network must be configured separately, before or after
2251 <code>ovs-vswitchd</code> is started.
2256 If not specified, the default is implementation-specific.
2261 <group title="Client Failure Detection and Handling">
2262 <column name="max_backoff">
2263 Maximum number of milliseconds to wait between connection attempts.
2264 Default is implementation-specific.
2267 <column name="inactivity_probe">
2268 Maximum number of milliseconds of idle time on connection to the client
2269 before sending an inactivity probe message. If Open vSwitch does not
2270 communicate with the client for the specified number of seconds, it
2271 will send a probe. If a response is not received for the same
2272 additional amount of time, Open vSwitch assumes the connection has been
2273 broken and attempts to reconnect. Default is implementation-specific.
2274 A value of 0 disables inactivity probes.
2278 <group title="Status">
2279 <column name="is_connected">
2280 <code>true</code> if currently connected to this manager,
2281 <code>false</code> otherwise.
2284 <column name="status" key="last_error">
2285 A human-readable description of the last error on the connection
2286 to the manager; i.e. <code>strerror(errno)</code>. This key
2287 will exist only if an error has occurred.
2290 <column name="status" key="state"
2291 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2293 The state of the connection to the manager:
2296 <dt><code>VOID</code></dt>
2297 <dd>Connection is disabled.</dd>
2299 <dt><code>BACKOFF</code></dt>
2300 <dd>Attempting to reconnect at an increasing period.</dd>
2302 <dt><code>CONNECTING</code></dt>
2303 <dd>Attempting to connect.</dd>
2305 <dt><code>ACTIVE</code></dt>
2306 <dd>Connected, remote host responsive.</dd>
2308 <dt><code>IDLE</code></dt>
2309 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2312 These values may change in the future. They are provided only for
2317 <column name="status" key="sec_since_connect"
2318 type='{"type": "integer", "minInteger": 0}'>
2319 The amount of time since this manager last successfully connected
2320 to the database (in seconds). Value is empty if manager has never
2321 successfully connected.
2324 <column name="status" key="sec_since_disconnect"
2325 type='{"type": "integer", "minInteger": 0}'>
2326 The amount of time since this manager last disconnected from the
2327 database (in seconds). Value is empty if manager has never
2331 <column name="status" key="locks_held">
2332 Space-separated list of the names of OVSDB locks that the connection
2333 holds. Omitted if the connection does not hold any locks.
2336 <column name="status" key="locks_waiting">
2337 Space-separated list of the names of OVSDB locks that the connection is
2338 currently waiting to acquire. Omitted if the connection is not waiting
2342 <column name="status" key="locks_lost">
2343 Space-separated list of the names of OVSDB locks that the connection
2344 has had stolen by another OVSDB client. Omitted if no locks have been
2345 stolen from this connection.
2348 <column name="status" key="n_connections"
2349 type='{"type": "integer", "minInteger": 2}'>
2351 When <ref column="target"/> specifies a connection method that
2352 listens for inbound connections (e.g. <code>ptcp:</code> or
2353 <code>pssl:</code>) and more than one connection is actually active,
2354 the value is the number of active connections. Otherwise, this
2355 key-value pair is omitted.
2358 When multiple connections are active, status columns and key-value
2359 pairs (other than this one) report the status of one arbitrarily
2365 <group title="Common Columns">
2366 The overall purpose of these columns is described under <code>Common
2367 Columns</code> at the beginning of this document.
2369 <column name="external_ids"/>
2373 <table name="NetFlow">
2374 A NetFlow target. NetFlow is a protocol that exports a number of
2375 details about terminating IP flows, such as the principals involved
2378 <column name="targets">
2379 NetFlow targets in the form
2380 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2381 must be specified numerically, not as a DNS name.
2384 <column name="engine_id">
2385 Engine ID to use in NetFlow messages. Defaults to datapath index
2389 <column name="engine_type">
2390 Engine type to use in NetFlow messages. Defaults to datapath
2391 index if not specified.
2394 <column name="active_timeout">
2395 The interval at which NetFlow records are sent for flows that are
2396 still active, in seconds. A value of <code>0</code> requests the
2397 default timeout (currently 600 seconds); a value of <code>-1</code>
2398 disables active timeouts.
2401 <column name="add_id_to_interface">
2402 <p>If this column's value is <code>false</code>, the ingress and egress
2403 interface fields of NetFlow flow records are derived from OpenFlow port
2404 numbers. When it is <code>true</code>, the 7 most significant bits of
2405 these fields will be replaced by the least significant 7 bits of the
2406 engine id. This is useful because many NetFlow collectors do not
2407 expect multiple switches to be sending messages from the same host, so
2408 they do not store the engine information which could be used to
2409 disambiguate the traffic.</p>
2410 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2413 <group title="Common Columns">
2414 The overall purpose of these columns is described under <code>Common
2415 Columns</code> at the beginning of this document.
2417 <column name="external_ids"/>
2422 SSL configuration for an Open_vSwitch.
2424 <column name="private_key">
2425 Name of a PEM file containing the private key used as the switch's
2426 identity for SSL connections to the controller.
2429 <column name="certificate">
2430 Name of a PEM file containing a certificate, signed by the
2431 certificate authority (CA) used by the controller and manager,
2432 that certifies the switch's private key, identifying a trustworthy
2436 <column name="ca_cert">
2437 Name of a PEM file containing the CA certificate used to verify
2438 that the switch is connected to a trustworthy controller.
2441 <column name="bootstrap_ca_cert">
2442 If set to <code>true</code>, then Open vSwitch will attempt to
2443 obtain the CA certificate from the controller on its first SSL
2444 connection and save it to the named PEM file. If it is successful,
2445 it will immediately drop the connection and reconnect, and from then
2446 on all SSL connections must be authenticated by a certificate signed
2447 by the CA certificate thus obtained. <em>This option exposes the
2448 SSL connection to a man-in-the-middle attack obtaining the initial
2449 CA certificate.</em> It may still be useful for bootstrapping.
2452 <group title="Common Columns">
2453 The overall purpose of these columns is described under <code>Common
2454 Columns</code> at the beginning of this document.
2456 <column name="external_ids"/>
2460 <table name="sFlow">
2461 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2464 <column name="agent">
2465 Name of the network device whose IP address should be reported as the
2466 ``agent address'' to collectors. If not specified, the IP address
2467 defaults to the <ref table="Controller" column="local_ip"/> in the
2468 collector's <ref table="Controller"/>. If an agent IP address cannot be
2469 determined either way, sFlow is disabled.
2472 <column name="header">
2473 Number of bytes of a sampled packet to send to the collector.
2474 If not specified, the default is 128 bytes.
2477 <column name="polling">
2478 Polling rate in seconds to send port statistics to the collector.
2479 If not specified, defaults to 30 seconds.
2482 <column name="sampling">
2483 Rate at which packets should be sampled and sent to the collector.
2484 If not specified, defaults to 400, which means one out of 400
2485 packets, on average, will be sent to the collector.
2488 <column name="targets">
2489 sFlow targets in the form
2490 <code><var>ip</var>:<var>port</var></code>.
2493 <group title="Common Columns">
2494 The overall purpose of these columns is described under <code>Common
2495 Columns</code> at the beginning of this document.
2497 <column name="external_ids"/>
2501 <table name="Capability">
2502 <p>Records in this table describe functionality supported by the hardware
2503 and software platform on which this Open vSwitch is based. Clients
2504 should not modify this table.</p>
2506 <p>A record in this table is meaningful only if it is referenced by the
2507 <ref table="Open_vSwitch" column="capabilities"/> column in the
2508 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2509 the record's ``category,'' determines the meanings of the
2510 <ref column="details"/> column. The following general forms of
2511 categories are currently defined:</p>
2514 <dt><code>qos-<var>type</var></code></dt>
2515 <dd><var>type</var> is supported as the value for
2516 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2520 <column name="details">
2521 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2522 depends on the category key that the <ref table="Open_vSwitch"
2523 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2524 uses to reference this record, as described above.</p>
2526 <p>The presence of a record for category <code>qos-<var>type</var></code>
2527 indicates that the switch supports <var>type</var> as the value of
2528 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2529 table. The following key-value pairs are defined to further describe
2530 QoS capabilities:</p>
2533 <dt><code>n-queues</code></dt>
2534 <dd>Number of supported queues, as a positive integer. Keys in the
2535 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2536 records whose <ref table="QoS" column="type"/> value
2537 equals <var>type</var> must range between 0 and this value minus one,