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 Statistics are disabled by default to avoid overhead in the common
109 case when statistics gathering is not useful. Set this value to
110 <code>true</code> to enable populating the <ref column="statistics"/>
111 column or to <code>false</code> to explicitly disable it.
114 <column name="statistics" key="cpu">
116 Number of CPU processors, threads, or cores currently online and
117 available to the operating system on which Open vSwitch is running,
118 as an integer. This may be less than the number installed, if some
119 are not online or if they are not available to the operating
123 Open vSwitch userspace processes are not multithreaded, but the
124 Linux kernel-based datapath is.
128 <column name="statistics" key="load_average">
129 A comma-separated list of three floating-point numbers,
130 representing the system load average over the last 1, 5, and 15
131 minutes, respectively.
134 <column name="statistics" key="memory">
136 A comma-separated list of integers, each of which represents a
137 quantity of memory in kilobytes that describes the operating
138 system on which Open vSwitch is running. In respective order,
143 <li>Total amount of RAM allocated to the OS.</li>
144 <li>RAM allocated to the OS that is in use.</li>
145 <li>RAM that can be flushed out to disk or otherwise discarded
146 if that space is needed for another purpose. This number is
147 necessarily less than or equal to the previous value.</li>
148 <li>Total disk space allocated for swap.</li>
149 <li>Swap space currently in use.</li>
153 On Linux, all five values can be determined and are included. On
154 other operating systems, only the first two values can be
155 determined, so the list will only have two values.
159 <column name="statistics" key="process_NAME">
161 One such key-value pair, with <code>NAME</code> replaced by
162 a process name, will exist for each running Open vSwitch
163 daemon process, with <var>name</var> replaced by the
164 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
165 value is a comma-separated list of integers. The integers
166 represent the following, with memory measured in kilobytes
167 and durations in milliseconds:
171 <li>The process's virtual memory size.</li>
172 <li>The process's resident set size.</li>
173 <li>The amount of user and system CPU time consumed by the
175 <li>The number of times that the process has crashed and been
176 automatically restarted by the monitor.</li>
177 <li>The duration since the process was started.</li>
178 <li>The duration for which the process has been running.</li>
182 The interpretation of some of these values depends on whether the
183 process was started with the <option>--monitor</option>. If it
184 was not, then the crash count will always be 0 and the two
185 durations will always be the same. If <option>--monitor</option>
186 was given, then the crash count may be positive; if it is, the
187 latter duration is the amount of time since the most recent crash
192 There will be one key-value pair for each file in Open vSwitch's
193 ``run directory'' (usually <code>/var/run/openvswitch</code>)
194 whose name ends in <code>.pid</code>, whose contents are a
195 process ID, and which is locked by a running process. The
196 <var>name</var> is taken from the pidfile's name.
200 Currently Open vSwitch is only able to obtain all of the above
201 detail on Linux systems. On other systems, the same key-value
202 pairs will be present but the values will always be the empty
207 <column name="statistics" key="file_systems">
209 A space-separated list of information on local, writable file
210 systems. Each item in the list describes one file system and
211 consists in turn of a comma-separated list of the following:
215 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
216 Any spaces or commas in the mount point are replaced by
218 <li>Total size, in kilobytes, as an integer.</li>
219 <li>Amount of storage in use, in kilobytes, as an integer.</li>
223 This key-value pair is omitted if there are no local, writable
224 file systems or if Open vSwitch cannot obtain the needed
231 <group title="Version Reporting">
233 These columns report the types and versions of the hardware and
234 software running Open vSwitch. We recommend in general that software
235 should test whether specific features are supported instead of relying
236 on version number checks. These values are primarily intended for
237 reporting to human administrators.
240 <column name="ovs_version">
241 The Open vSwitch version number, e.g. <code>1.1.0</code>.
242 If Open vSwitch was configured with a build number, then it is
243 also included, e.g. <code>1.1.0+build6579</code>.
246 <column name="db_version">
248 The database schema version number in the form
249 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
250 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
251 a non-backward compatible way (e.g. deleting a column or a table),
252 <var>major</var> is incremented. When the database schema is changed
253 in a backward compatible way (e.g. adding a new column),
254 <var>minor</var> is incremented. When the database schema is changed
255 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
260 The schema version is part of the database schema, so it can also be
261 retrieved by fetching the schema using the Open vSwitch database
266 <column name="system_type">
268 An identifier for the type of system on top of which Open vSwitch
269 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
272 System integrators are responsible for choosing and setting an
273 appropriate value for this column.
277 <column name="system_version">
279 The version of the system identified by <ref column="system_type"/>,
280 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
283 System integrators are responsible for choosing and setting an
284 appropriate value for this column.
290 <group title="Database Configuration">
292 These columns primarily configure the Open vSwitch database
293 (<code>ovsdb-server</code>), not the Open vSwitch switch
294 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
295 column="ssl"/> settings.
299 The Open vSwitch switch does read the database configuration to
300 determine remote IP addresses to which in-band control should apply.
303 <column name="manager_options">
304 Database clients to which the Open vSwitch database server should
305 connect or to which it should listen, along with options for how these
306 connection should be configured. See the <ref table="Manager"/> table
307 for more information.
311 <group title="Common Columns">
312 The overall purpose of these columns is described under <code>Common
313 Columns</code> at the beginning of this document.
315 <column name="other_config"/>
316 <column name="external_ids"/>
320 <table name="Bridge">
322 Configuration for a bridge within an
323 <ref table="Open_vSwitch"/>.
326 A <ref table="Bridge"/> record represents an Ethernet switch with one or
327 more ``ports,'' which are the <ref table="Port"/> records pointed to by
328 the <ref table="Bridge"/>'s <ref column="ports"/> column.
331 <group title="Core Features">
333 Bridge identifier. Should be alphanumeric and no more than about 8
334 bytes long. Must be unique among the names of ports, interfaces, and
338 <column name="ports">
339 Ports included in the bridge.
342 <column name="mirrors">
343 Port mirroring configuration.
346 <column name="netflow">
347 NetFlow configuration.
350 <column name="sflow">
354 <column name="flood_vlans">
356 VLAN IDs of VLANs on which MAC address learning should be disabled,
357 so that packets are flooded instead of being sent to specific ports
358 that are believed to contain packets' destination MACs. This should
359 ordinarily be used to disable MAC learning on VLANs used for
360 mirroring (RSPAN VLANs). It may also be useful for debugging.
363 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
364 the <ref table="Port"/> table) is incompatible with
365 <code>flood_vlans</code>. Consider using another bonding mode or
366 a different type of mirror instead.
371 <group title="OpenFlow Configuration">
372 <column name="controller">
373 OpenFlow controller set. If unset, then no OpenFlow controllers
377 <column name="fail_mode">
378 <p>When a controller is configured, it is, ordinarily, responsible
379 for setting up all flows on the switch. Thus, if the connection to
380 the controller fails, no new network connections can be set up.
381 If the connection to the controller stays down long enough,
382 no packets can pass through the switch at all. This setting
383 determines the switch's response to such a situation. It may be set
384 to one of the following:
386 <dt><code>standalone</code></dt>
387 <dd>If no message is received from the controller for three
388 times the inactivity probe interval
389 (see <ref column="inactivity_probe"/>), then Open vSwitch
390 will take over responsibility for setting up flows. In
391 this mode, Open vSwitch causes the bridge to act like an
392 ordinary MAC-learning switch. Open vSwitch will continue
393 to retry connecting to the controller in the background
394 and, when the connection succeeds, it will discontinue its
395 standalone behavior.</dd>
396 <dt><code>secure</code></dt>
397 <dd>Open vSwitch will not set up flows on its own when the
398 controller connection fails or when no controllers are
399 defined. The bridge will continue to retry connecting to
400 any defined controllers forever.</dd>
403 <p>If this value is unset, the default is implementation-specific.</p>
404 <p>When more than one controller is configured,
405 <ref column="fail_mode"/> is considered only when none of the
406 configured controllers can be contacted.</p>
409 <column name="datapath_id">
410 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
411 (Setting this column has no useful effect. Set <ref
412 column="other-config" key="datapath-id"/> instead.)
415 <column name="other_config" key="datapath-id">
416 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
417 value. May not be all-zero.
420 <column name="other_config" key="disable-in-band">
421 If set to <code>true</code>, disable in-band control on the bridge
422 regardless of controller and manager settings.
425 <column name="other_config" key="in-band-queue">
426 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
427 that will be used by flows set up by in-band control on this bridge.
428 If unset, or if the port used by an in-band control flow does not have
429 QoS configured, or if the port does not have a queue with the specified
430 ID, the default queue is used instead.
434 <group title="Other Features">
435 <column name="datapath_type">
436 Name of datapath provider. The kernel datapath has
437 type <code>system</code>. The userspace datapath has
438 type <code>netdev</code>.
441 <column name="external_ids" key="bridge-id">
442 A unique identifier of the bridge. On Citrix XenServer this will
443 commonly be the same as
444 <ref column="external_ids" key="xs-network-uuids"/>.
447 <column name="external_ids" key="xs-network-uuids">
448 Semicolon-delimited set of universally unique identifier(s) for the
449 network with which this bridge is associated on a Citrix XenServer
450 host. The network identifiers are RFC 4122 UUIDs as displayed by,
451 e.g., <code>xe network-list</code>.
454 <column name="other_config" key="hwaddr">
455 An Ethernet address in the form
456 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
457 to set the hardware address of the local port and influence the
461 <column name="other_config" key="flow-eviction-threshold">
463 A number of flows as a nonnegative integer. This sets number of
464 flows at which eviction from the kernel flow table will be triggered.
465 If there are a large number of flows then increasing this value to
466 around the number of flows present can result in reduced CPU usage
470 The default is 1000. Values below 100 will be rounded up to 100.
474 <column name="other_config" key="forward-bpdu">
475 Option to allow forwarding of BPDU frames when NORMAL action if
476 invoked. Frames with reserved Ethernet addresses (e.g. STP BPDU) will
477 be forwarded when this option is enabled. If the Open vSwitch bridge
478 is used to connect different Ethernet networks, and if Open vSwitch
479 node does not run STP, then this option should be enabled. Default is
480 disabled, set to <code>true</code> to enable.
484 <group title="Common Columns">
485 The overall purpose of these columns is described under <code>Common
486 Columns</code> at the beginning of this document.
488 <column name="other_config"/>
489 <column name="external_ids"/>
493 <table name="Port" table="Port or bond configuration.">
494 <p>A port within a <ref table="Bridge"/>.</p>
495 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
496 <ref column="interfaces"/> column. Such a port logically
497 corresponds to a port on a physical Ethernet switch. A port
498 with more than one interface is a ``bonded port'' (see
499 <ref group="Bonding Configuration"/>).</p>
500 <p>Some properties that one might think as belonging to a port are actually
501 part of the port's <ref table="Interface"/> members.</p>
504 Port name. Should be alphanumeric and no more than about 8
505 bytes long. May be the same as the interface name, for
506 non-bonded ports. Must otherwise be unique among the names of
507 ports, interfaces, and bridges on a host.
510 <column name="interfaces">
511 The port's interfaces. If there is more than one, this is a
515 <group title="VLAN Configuration">
516 <p>Bridge ports support the following types of VLAN configuration:</p>
521 A trunk port carries packets on one or more specified VLANs
522 specified in the <ref column="trunks"/> column (often, on every
523 VLAN). A packet that ingresses on a trunk port is in the VLAN
524 specified in its 802.1Q header, or VLAN 0 if the packet has no
525 802.1Q header. A packet that egresses through a trunk port will
526 have a 802.1Q header if it has a nonzero VLAN ID (or a nonzero
531 Any packet that ingresses on a trunk port tagged with a VLAN that
532 the port does not trunk is dropped.
539 An access port carries packets on exactly one VLAN specified in the
540 <ref column="tag"/> column. Packets ingressing and egressing on an
541 access port have no 802.1Q header.
545 Any packet with an 802.1Q header that ingresses on an access port
546 is dropped, regardless of whether the VLAN ID in the header is the
547 access port's VLAN ID.
551 <dt>native-tagged</dt>
553 A native-tagged port resembles a trunk port, with the exception that
554 a packet without an 802.1Q header that ingresses on a native-tagged
555 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
559 <dt>native-untagged</dt>
561 A native-untagged port resembles a native-tagged port, with the
562 exception that a packet that egresses on a native-untagged port in
563 the native VLAN not have an 802.1Q header.
567 A packet will only egress through bridge ports that carry the VLAN of
568 the packet, as described by the rules above.
571 <column name="vlan_mode">
573 The VLAN mode of the port, as described above. When this column is
574 empty, a default mode is selected as follows:
578 If <ref column="tag"/> contains a value, the port is an access
579 port. The <ref column="trunks"/> column should be empty.
582 Otherwise, the port is a trunk port. The <ref column="trunks"/>
583 column value is honored if it is present.
590 For an access port, the port's implicitly tagged VLAN. For a
591 native-tagged or native-untagged port, the port's native VLAN. Must
592 be empty if this is a trunk port.
596 <column name="trunks">
598 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
599 or VLANs that this port trunks; if it is empty, then the port trunks
600 all VLANs. Must be empty if this is an access port.
603 A native-tagged or native-untagged port always trunks its native
604 VLAN, regardless of whether <ref column="trunks"/> includes that
610 <group title="Bonding Configuration">
611 <p>A port that has more than one interface is a ``bonded port.'' Bonding
612 allows for load balancing and fail-over. Some kinds of bonding will
613 work with any kind of upstream switch:</p>
616 <dt><code>balance-slb</code></dt>
618 Balances flows among slaves based on source MAC address and output
619 VLAN, with periodic rebalancing as traffic patterns change.
622 <dt><code>active-backup</code></dt>
624 Assigns all flows to one slave, failing over to a backup slave when
625 the active slave is disabled.
630 The following modes require the upstream switch to support 802.3ad with
631 successful LACP negotiation. If LACP negotiation fails then
632 <code>balance-slb</code> style flow hashing is used as a fallback:
636 <dt><code>balance-tcp</code></dt>
638 Balances flows among slaves based on L2, L3, and L4 protocol
639 information such as destination MAC address, IP address, and TCP
643 <dt><code>stable</code></dt>
645 <p>Attempts to always assign a given flow to the same slave
646 consistently. In an effort to maintain stability, no load
647 balancing is done. Uses a similar hashing strategy to
648 <code>balance-tcp</code>, always taking into account L3 and L4
649 fields even if LACP negotiations are unsuccessful. </p>
650 <p>Slave selection decisions are made based on <ref table="Interface"
651 column="other_config" key="bond-stable-id"/> if set. Otherwise,
652 OpenFlow port number is used. Decisions are consistent across all
653 <code>ovs-vswitchd</code> instances with equivalent
654 <ref table="Interface" column="other_config" key="bond-stable-id"/>
659 <p>These columns apply only to bonded ports. Their values are
660 otherwise ignored.</p>
662 <column name="bond_mode">
663 <p>The type of bonding used for a bonded port. Defaults to
664 <code>balance-slb</code> if unset.
668 <group title="Link Failure Detection">
670 An important part of link bonding is detecting that links are down so
671 that they may be disabled. These settings determine how Open vSwitch
672 detects link failure.
675 <column name="other_config" key="bond-detect-mode">
676 The means used to detect link failures. Options are
677 <code>carrier</code> and <code>miimon</code>. Defaults to
678 <code>carrier</code> which uses each interface's carrier to detect
679 failures. When set to <code>miimon</code>, will check for failures
680 by polling each interface's MII.
683 <column name="other_config" key="bond-miimon-interval">
684 The interval, in milliseconds, between successive attempts to poll
685 each interface's MII. Relevant only when <ref column="other_config"
686 key="bond-detect-mode"/> is <code>miimon</code>.
689 <column name="bond_updelay">
691 The number of milliseconds for which carrier must stay up on an
692 interface before the interface is considered to be up. Specify
693 <code>0</code> to enable the interface immediately.
697 This setting is honored only when at least one bonded interface is
698 already enabled. When no interfaces are enabled, then the first
699 bond interface to come up is enabled immediately.
703 <column name="bond_downdelay">
704 The number of milliseconds for which carrier must stay down on an
705 interface before the interface is considered to be down. Specify
706 <code>0</code> to disable the interface immediately.
710 <group title="LACP Configuration">
712 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
713 allows switches to automatically detect that they are connected by
714 multiple links and aggregate across those links. These settings
715 control LACP behavior.
719 Configures LACP on this port. LACP allows directly connected
720 switches to negotiate which links may be bonded. LACP may be enabled
721 on non-bonded ports for the benefit of any switches they may be
722 connected to. <code>active</code> ports are allowed to initiate LACP
723 negotiations. <code>passive</code> ports are allowed to participate
724 in LACP negotiations initiated by a remote switch, but not allowed to
725 initiate such negotiations themselves. Defaults to <code>off</code>
729 <column name="other_config" key="lacp-system-id">
730 The LACP system ID of this <ref table="Port"/>. The system ID of a
731 LACP bond is used to identify itself to its partners. Must be a
735 <column name="other_config" key="lacp-system-priority">
736 The LACP system priority of this <ref table="Port"/>. In LACP
737 negotiations, link status decisions are made by the system with the
738 numerically lower priority. Must be a number between 1 and 65535.
741 <column name="other_config" key="lacp-time">
743 The LACP timing which should be used on this <ref table="Port"/>.
744 Possible values are <code>fast</code>, <code>slow</code> and a
745 positive number of milliseconds. By default <code>slow</code> is
746 used. When configured to be <code>fast</code> LACP heartbeats are
747 requested at a rate of once per second causing connectivity
748 problems to be detected more quickly. In <code>slow</code> mode,
749 heartbeats are requested at a rate of once every 30 seconds.
753 Users may manually set a heartbeat transmission rate to increase
754 the fault detection speed further. When manually set, OVS expects
755 the partner switch to be configured with the same transmission
756 rate. Manually setting <code>lacp-time</code> to something other
757 than <code>fast</code> or <code>slow</code> is not supported by the
762 <column name="other_config" key="lacp-heartbeat">
763 Treats LACP like a simple heartbeat protocol for link state
764 monitoring. Most features of the LACP protocol are disabled when
768 <column name="other_config" key="bond-hash-basis">
769 An integer hashed along with flows when choosing output slaves. When
770 changed, all flows will be assigned different hash values possibly
771 causing slave selection decisions to change.
775 <group title="SLB Configuration">
777 These settings control behavior when a bond is in
778 <code>balance-slb</code> mode, regardless of whether the bond was
779 intentionally configured in SLB mode or it fell back to SLB mode
780 because LACP negotiation failed.
783 <column name="other_config" key="bond-rebalance-interval">
784 For an SLB bonded port, the number of milliseconds between successive
785 attempts to rebalance the bond, that is, to move source MACs and
786 their flows from one interface on the bond to another in an attempt
787 to keep usage of each interface roughly equal. The default is 10000
788 (10 seconds), and the minimum is 1000 (1 second).
792 <column name="bond_fake_iface">
793 For a bonded port, whether to create a fake internal interface with the
794 name of the port. Use only for compatibility with legacy software that
799 <group title="Other Features">
801 Quality of Service configuration for this port.
805 The MAC address to use for this port for the purpose of choosing the
806 bridge's MAC address. This column does not necessarily reflect the
807 port's actual MAC address, nor will setting it change the port's actual
811 <column name="fake_bridge">
812 Does this port represent a sub-bridge for its tagged VLAN within the
813 Bridge? See ovs-vsctl(8) for more information.
816 <column name="external_ids" key="fake-bridge-id-*">
817 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
818 column) are defined by prefixing a <ref table="Bridge"/> <ref
819 table="Bridge" column="external_ids"/> key with
820 <code>fake-bridge-</code>,
821 e.g. <code>fake-bridge-xs-network-uuids</code>.
825 <group title="Common Columns">
826 The overall purpose of these columns is described under <code>Common
827 Columns</code> at the beginning of this document.
829 <column name="other_config"/>
830 <column name="external_ids"/>
834 <table name="Interface" title="One physical network device in a Port.">
835 An interface within a <ref table="Port"/>.
837 <group title="Core Features">
839 Interface name. Should be alphanumeric and no more than about 8 bytes
840 long. May be the same as the port name, for non-bonded ports. Must
841 otherwise be unique among the names of ports, interfaces, and bridges
846 <p>Ethernet address to set for this interface. If unset then the
847 default MAC address is used:</p>
849 <li>For the local interface, the default is the lowest-numbered MAC
850 address among the other bridge ports, either the value of the
851 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
852 if set, or its actual MAC (for bonded ports, the MAC of its slave
853 whose name is first in alphabetical order). Internal ports and
854 bridge ports that are used as port mirroring destinations (see the
855 <ref table="Mirror"/> table) are ignored.</li>
856 <li>For other internal interfaces, the default MAC is randomly
858 <li>External interfaces typically have a MAC address associated with
861 <p>Some interfaces may not have a software-controllable MAC
865 <column name="ofport">
866 <p>OpenFlow port number for this interface. Unlike most columns, this
867 column's value should be set only by Open vSwitch itself. Other
868 clients should set this column to an empty set (the default) when
869 creating an <ref table="Interface"/>.</p>
870 <p>Open vSwitch populates this column when the port number becomes
871 known. If the interface is successfully added,
872 <ref column="ofport"/> will be set to a number between 1 and 65535
873 (generally either in the range 1 to 65279, inclusive, or 65534, the
874 port number for the OpenFlow ``local port''). If the interface
875 cannot be added then Open vSwitch sets this column
880 <group title="System-Specific Details">
883 The interface type, one of:
887 <dt><code>system</code></dt>
888 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
889 Sometimes referred to as ``external interfaces'' since they are
890 generally connected to hardware external to that on which the Open
891 vSwitch is running. The empty string is a synonym for
892 <code>system</code>.</dd>
894 <dt><code>internal</code></dt>
895 <dd>A simulated network device that sends and receives traffic. An
896 internal interface whose <ref column="name"/> is the same as its
897 bridge's <ref table="Open_vSwitch" column="name"/> is called the
898 ``local interface.'' It does not make sense to bond an internal
899 interface, so the terms ``port'' and ``interface'' are often used
900 imprecisely for internal interfaces.</dd>
902 <dt><code>tap</code></dt>
903 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
905 <dt><code>gre</code></dt>
907 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
908 tunnel. See <ref group="Tunnel Options"/> for information on
909 configuring GRE tunnels.
912 <dt><code>ipsec_gre</code></dt>
914 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
918 <dt><code>capwap</code></dt>
920 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
921 5415). This allows interoperability with certain switches that do
922 not support GRE. Only the tunneling component of the protocol is
923 implemented. UDP ports 58881 and 58882 are used as the source and
924 destination ports respectively. CAPWAP is currently supported only
925 with the Linux kernel datapath with kernel version 2.6.25 or later.
928 <dt><code>patch</code></dt>
930 A pair of virtual devices that act as a patch cable.
933 <dt><code>null</code></dt>
934 <dd>An ignored interface.</dd>
939 <group title="Tunnel Options">
941 These options apply to interfaces with <ref column="type"/> of
942 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
946 Each tunnel must be uniquely identified by the combination of <ref
947 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
948 column="options" key="local_ip"/>, and <ref column="options"
949 key="in_key"/>. If two ports are defined that are the same except one
950 has an optional identifier and the other does not, the more specific
951 one is matched first. <ref column="options" key="in_key"/> is
952 considered more specific than <ref column="options" key="local_ip"/> if
953 a port defines one and another port defines the other.
956 <column name="options" key="remote_ip">
957 Required. The tunnel endpoint.
960 <column name="options" key="local_ip">
961 Optional. The destination IP that received packets must
962 match. Default is to match all addresses.
965 <column name="options" key="in_key">
966 <p>Optional. The key that received packets must contain, one of:</p>
970 <code>0</code>. The tunnel receives packets with no key or with a
971 key of 0. This is equivalent to specifying no <ref column="options"
972 key="in_key"/> at all.
975 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
976 tunnel receives only packets with the specified key.
979 The word <code>flow</code>. The tunnel accepts packets with any
980 key. The key will be placed in the <code>tun_id</code> field for
981 matching in the flow table. The <code>ovs-ofctl</code> manual page
982 contains additional information about matching fields in OpenFlow
991 <column name="options" key="out_key">
992 <p>Optional. The key to be set on outgoing packets, one of:</p>
996 <code>0</code>. Packets sent through the tunnel will have no key.
997 This is equivalent to specifying no <ref column="options"
998 key="out_key"/> at all.
1001 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1002 sent through the tunnel will have the specified key.
1005 The word <code>flow</code>. Packets sent through the tunnel will
1006 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1007 vendor extension (0 is used in the absence of an action). The
1008 <code>ovs-ofctl</code> manual page contains additional information
1009 about the Nicira OpenFlow vendor extensions.
1014 <column name="options" key="key">
1015 Optional. Shorthand to set <code>in_key</code> and
1016 <code>out_key</code> at the same time.
1019 <column name="options" key="tos">
1020 Optional. The value of the ToS bits to be set on the encapsulating
1021 packet. It may also be the word <code>inherit</code>, in which case
1022 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1023 (otherwise it will be 0). The ECN fields are always inherited.
1027 <column name="options" key="ttl">
1028 Optional. The TTL to be set on the encapsulating packet. It may also
1029 be the word <code>inherit</code>, in which case the TTL will be copied
1030 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1031 system default, typically 64). Default is the system default TTL.
1034 <column name="options" key="df_inherit">
1035 Optional. If enabled, the Don't Fragment bit will be copied from the
1036 inner IP headers (those of the encapsulated traffic) to the outer
1037 (tunnel) headers. Default is disabled; set to <code>true</code> to
1041 <column name="options" key="df_default">
1042 Optional. If enabled, the Don't Fragment bit will be set by default on
1043 tunnel headers if the <code>df_inherit</code> option is not set, or if
1044 the encapsulated packet is not IP. Default is enabled; set to
1045 <code>false</code> to disable.
1048 <column name="options" key="pmtud">
1049 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1050 Destination Unreachable - Fragmentation Needed'' messages will be
1051 generated for IPv4 packets with the DF bit set and IPv6 packets above
1052 the minimum MTU if the packet size exceeds the path MTU minus the size
1053 of the tunnel headers. Note that this option causes behavior that is
1054 typically reserved for routers and therefore is not entirely in
1055 compliance with the IEEE 802.1D specification for bridges. Default is
1056 enabled; set to <code>false</code> to disable.
1059 <group title="Tunnel Options: gre only">
1061 Only <code>gre</code> interfaces support these options.
1064 <column name="options" key="header_cache">
1065 Enable caching of tunnel headers and the output path. This can lead
1066 to a significant performance increase without changing behavior. In
1067 general it should not be necessary to adjust this setting. However,
1068 the caching can bypass certain components of the IP stack (such as
1069 <code>iptables</code>) and it may be useful to disable it if these
1070 features are required or as a debugging measure. Default is enabled,
1071 set to <code>false</code> to disable.
1075 <group title="Tunnel Options: gre and ipsec_gre only">
1077 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1081 <column name="options" key="csum">
1083 Optional. Compute GRE checksums on outgoing packets. Default is
1084 disabled, set to <code>true</code> to enable. Checksums present on
1085 incoming packets will be validated regardless of this setting.
1089 GRE checksums impose a significant performance penalty because they
1090 cover the entire packet. The encapsulated L3, L4, and L7 packet
1091 contents typically have their own checksums, so this additional
1092 checksum only adds value for the GRE and encapsulated L2 headers.
1096 This option is supported for <code>ipsec_gre</code>, but not useful
1097 because GRE checksums are weaker than, and redundant with, IPsec
1098 payload authentication.
1103 <group title="Tunnel Options: ipsec_gre only">
1105 Only <code>ipsec_gre</code> interfaces support these options.
1108 <column name="options" key="peer_cert">
1109 Required for certificate authentication. A string containing the
1110 peer's certificate in PEM format. Additionally the host's
1111 certificate must be specified with the <code>certificate</code>
1115 <column name="options" key="certificate">
1116 Required for certificate authentication. The name of a PEM file
1117 containing a certificate that will be presented to the peer during
1121 <column name="options" key="private_key">
1122 Optional for certificate authentication. The name of a PEM file
1123 containing the private key associated with <code>certificate</code>.
1124 If <code>certificate</code> contains the private key, this option may
1128 <column name="options" key="psk">
1129 Required for pre-shared key authentication. Specifies a pre-shared
1130 key for authentication that must be identical on both sides of the
1136 <group title="Patch Options">
1138 Only <code>patch</code> interfaces support these options.
1141 <column name="options" key="peer">
1142 The <ref column="name"/> of the <ref table="Interface"/> for the other
1143 side of the patch. The named <ref table="Interface"/>'s own
1144 <code>peer</code> option must specify this <ref table="Interface"/>'s
1145 name. That is, the two patch interfaces must have reversed <ref
1146 column="name"/> and <code>peer</code> values.
1150 <group title="Interface Status">
1152 Status information about interfaces attached to bridges, updated every
1153 5 seconds. Not all interfaces have all of these properties; virtual
1154 interfaces don't have a link speed, for example. Non-applicable
1155 columns will have empty values.
1157 <column name="admin_state">
1159 The administrative state of the physical network link.
1163 <column name="link_state">
1165 The observed state of the physical network link. This is ordinarily
1166 the link's carrier status. If the interface's <ref table="Port"/> is
1167 a bond configured for miimon monitoring, it is instead the network
1168 link's miimon status.
1172 <column name="link_speed">
1174 The negotiated speed of the physical network link.
1175 Valid values are positive integers greater than 0.
1179 <column name="duplex">
1181 The duplex mode of the physical network link.
1187 The MTU (maximum transmission unit); i.e. the largest
1188 amount of data that can fit into a single Ethernet frame.
1189 The standard Ethernet MTU is 1500 bytes. Some physical media
1190 and many kinds of virtual interfaces can be configured with
1194 This column will be empty for an interface that does not
1195 have an MTU as, for example, some kinds of tunnels do not.
1199 <column name="lacp_current">
1200 Boolean value indicating LACP status for this interface. If true, this
1201 interface has current LACP information about its LACP partner. This
1202 information may be used to monitor the health of interfaces in a LACP
1203 enabled port. This column will be empty if LACP is not enabled.
1206 <column name="status">
1207 Key-value pairs that report port status. Supported status values are
1208 <ref column="type"/>-dependent; some interfaces may not have a valid
1209 <ref column="status" key="driver_name"/>, for example.
1212 <column name="status" key="driver_name">
1213 The name of the device driver controlling the network adapter.
1216 <column name="status" key="driver_version">
1217 The version string of the device driver controlling the network
1221 <column name="status" key="firmware_version">
1222 The version string of the network adapter's firmware, if available.
1225 <column name="status" key="source_ip">
1226 The source IP address used for an IPv4 tunnel end-point, such as
1227 <code>gre</code> or <code>capwap</code>.
1230 <column name="status" key="tunnel_egress_iface">
1231 Egress interface for tunnels. Currently only relevant for GRE and
1232 CAPWAP tunnels. On Linux systems, this column will show the name of
1233 the interface which is responsible for routing traffic destined for the
1234 configured <ref column="options" key="remote_ip"/>. This could be an
1235 internal interface such as a bridge port.
1238 <column name="status" key="tunnel_egress_iface_carrier">
1239 Whether a carrier is detected on <ref column="status"
1240 key="tunnel_egress_iface"/>. Valid values are <code>down</code> and
1245 <group title="Statistics">
1247 Key-value pairs that report interface statistics. The current
1248 implementation updates these counters periodically. Future
1249 implementations may update them when an interface is created, when they
1250 are queried (e.g. using an OVSDB <code>select</code> operation), and
1251 just before an interface is deleted due to virtual interface hot-unplug
1252 or VM shutdown, and perhaps at other times, but not on any regular
1256 These are the same statistics reported by OpenFlow in its <code>struct
1257 ofp_port_stats</code> structure. If an interface does not support a
1258 given statistic, then that pair is omitted.
1260 <group title="Statistics: Successful transmit and receive counters">
1261 <column name="statistics" key="rx_packets">
1262 Number of received packets.
1264 <column name="statistics" key="rx_bytes">
1265 Number of received bytes.
1267 <column name="statistics" key="tx_packets">
1268 Number of transmitted packets.
1270 <column name="statistics" key="tx_bytes">
1271 Number of transmitted bytes.
1274 <group title="Statistics: Receive errors">
1275 <column name="statistics" key="rx_dropped">
1276 Number of packets dropped by RX.
1278 <column name="statistics" key="rx_frame_err">
1279 Number of frame alignment errors.
1281 <column name="statistics" key="rx_over_err">
1282 Number of packets with RX overrun.
1284 <column name="statistics" key="rx_crc_err">
1285 Number of CRC errors.
1287 <column name="statistics" key="rx_errors">
1288 Total number of receive errors, greater than or equal to the sum of
1292 <group title="Statistics: Transmit errors">
1293 <column name="statistics" key="tx_dropped">
1294 Number of packets dropped by TX.
1296 <column name="statistics" key="collisions">
1297 Number of collisions.
1299 <column name="statistics" key="tx_errors">
1300 Total number of transmit errors, greater than or equal to the sum of
1306 <group title="Ingress Policing">
1308 These settings control ingress policing for packets received on this
1309 interface. On a physical interface, this limits the rate at which
1310 traffic is allowed into the system from the outside; on a virtual
1311 interface (one connected to a virtual machine), this limits the rate at
1312 which the VM is able to transmit.
1315 Policing is a simple form of quality-of-service that simply drops
1316 packets received in excess of the configured rate. Due to its
1317 simplicity, policing is usually less accurate and less effective than
1318 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1319 table="Queue"/> tables).
1322 Policing is currently implemented only on Linux. The Linux
1323 implementation uses a simple ``token bucket'' approach:
1327 The size of the bucket corresponds to <ref
1328 column="ingress_policing_burst"/>. Initially the bucket is full.
1331 Whenever a packet is received, its size (converted to tokens) is
1332 compared to the number of tokens currently in the bucket. If the
1333 required number of tokens are available, they are removed and the
1334 packet is forwarded. Otherwise, the packet is dropped.
1337 Whenever it is not full, the bucket is refilled with tokens at the
1338 rate specified by <ref column="ingress_policing_rate"/>.
1342 Policing interacts badly with some network protocols, and especially
1343 with fragmented IP packets. Suppose that there is enough network
1344 activity to keep the bucket nearly empty all the time. Then this token
1345 bucket algorithm will forward a single packet every so often, with the
1346 period depending on packet size and on the configured rate. All of the
1347 fragments of an IP packets are normally transmitted back-to-back, as a
1348 group. In such a situation, therefore, only one of these fragments
1349 will be forwarded and the rest will be dropped. IP does not provide
1350 any way for the intended recipient to ask for only the remaining
1351 fragments. In such a case there are two likely possibilities for what
1352 will happen next: either all of the fragments will eventually be
1353 retransmitted (as TCP will do), in which case the same problem will
1354 recur, or the sender will not realize that its packet has been dropped
1355 and data will simply be lost (as some UDP-based protocols will do).
1356 Either way, it is possible that no forward progress will ever occur.
1358 <column name="ingress_policing_rate">
1360 Maximum rate for data received on this interface, in kbps. Data
1361 received faster than this rate is dropped. Set to <code>0</code>
1362 (the default) to disable policing.
1366 <column name="ingress_policing_burst">
1367 <p>Maximum burst size for data received on this interface, in kb. The
1368 default burst size if set to <code>0</code> is 1000 kb. This value
1369 has no effect if <ref column="ingress_policing_rate"/>
1370 is <code>0</code>.</p>
1372 Specifying a larger burst size lets the algorithm be more forgiving,
1373 which is important for protocols like TCP that react severely to
1374 dropped packets. The burst size should be at least the size of the
1375 interface's MTU. Specifying a value that is numerically at least as
1376 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1377 closer to achieving the full rate.
1382 <group title="Connectivity Fault Management">
1384 802.1ag Connectivity Fault Management (CFM) allows a group of
1385 Maintenance Points (MPs) called a Maintenance Association (MA) to
1386 detect connectivity problems with each other. MPs within a MA should
1387 have complete and exclusive interconnectivity. This is verified by
1388 occasionally broadcasting Continuity Check Messages (CCMs) at a
1389 configurable transmission interval.
1393 According to the 802.1ag specification, each Maintenance Point should
1394 be configured out-of-band with a list of Remote Maintenance Points it
1395 should have connectivity to. Open vSwitch differs from the
1396 specification in this area. It simply assumes the link is faulted if
1397 no Remote Maintenance Points are reachable, and considers it not
1401 <column name="cfm_mpid">
1402 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1403 a Maintenance Association. The MPID is used to identify this endpoint
1404 to other Maintenance Points in the MA. Each end of a link being
1405 monitored should have a different MPID. Must be configured to enable
1406 CFM on this <ref table="Interface"/>.
1409 <column name="cfm_fault">
1411 Indicates a connectivity fault triggered by an inability to receive
1412 heartbeats from any remote endpoint. When a fault is triggered on
1413 <ref table="Interface"/>s participating in bonds, they will be
1417 Faults can be triggered for several reasons. Most importantly they
1418 are triggered when no CCMs are received for a period of 3.5 times the
1419 transmission interval. Faults are also triggered when any CCMs
1420 indicate that a Remote Maintenance Point is not receiving CCMs but
1421 able to send them. Finally, a fault is triggered if a CCM is
1422 received which indicates unexpected configuration. Notably, this
1423 case arises when a CCM is received which advertises the local MPID.
1427 <column name="cfm_remote_mpids">
1428 When CFM is properly configured, Open vSwitch will occasionally
1429 receive CCM broadcasts. These broadcasts contain the MPID of the
1430 sending Maintenance Point. The list of MPIDs from which this
1431 <ref table="Interface"/> is receiving broadcasts from is regularly
1432 collected and written to this column.
1435 <column name="other_config" key="cfm_interval">
1436 The interval, in milliseconds, between transmissions of CFM heartbeats.
1437 Three missed heartbeat receptions indicate a connectivity fault.
1441 <column name="other_config" key="cfm_extended">
1442 When <code>true</code>, the CFM module operates in extended mode. This
1443 causes it to use a nonstandard destination address to avoid conflicting
1444 with compliant implementations which may be running concurrently on the
1445 network. Furthermore, extended mode increases the accuracy of the
1446 <code>cfm_interval</code> configuration parameter by breaking wire
1447 compatibility with 802.1ag compliant implementations. Defaults to
1452 <group title="Bonding Configuration">
1453 <column name="other_config" key="bond-stable-id">
1454 A positive integer using in <code>stable</code> bond mode to make slave
1455 selection decisions. Allocating <ref column="other_config"
1456 key="bond-stable-id"/> values consistently across interfaces
1457 participating in a bond will guarantee consistent slave selection
1458 decisions across <code>ovs-vswitchd</code> instances when using
1459 <code>stable</code> bonding mode.
1462 <column name="other_config" key="lacp-port-id">
1463 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1464 used in LACP negotiations to identify individual ports
1465 participating in a bond. Must be a number between 1 and
1469 <column name="other_config" key="lacp-port-priority">
1470 The LACP port priority of this <ref table="Interface"/>. In LACP
1471 negotiations <ref table="Interface"/>s with numerically lower
1472 priorities are preferred for aggregation. Must be a number between 1
1476 <column name="other_config" key="lacp-aggregation-key">
1477 The LACP aggregation key of this <ref table="Interface"/>. <ref
1478 table="Interface"/>s with different aggregation keys may not be active
1479 within a given <ref table="Port"/> at the same time. Must be a number
1480 between 1 and 65535.
1484 <group title="Virtual Machine Identifiers">
1486 These key-value pairs specifically apply to an interface that
1487 represents a virtual Ethernet interface connected to a virtual
1488 machine. These key-value pairs should not be present for other types
1489 of interfaces. Keys whose names end in <code>-uuid</code> have
1490 values that uniquely identify the entity in question. For a Citrix
1491 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1492 Other hypervisors may use other formats.
1495 <column name="external_ids" key="attached-mac">
1496 The MAC address programmed into the ``virtual hardware'' for this
1497 interface, in the form
1498 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1499 For Citrix XenServer, this is the value of the <code>MAC</code> field
1500 in the VIF record for this interface.
1503 <column name="external_ids" key="iface-id">
1504 A system-unique identifier for the interface. On XenServer, this will
1505 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1508 <column name="external_ids" key="xs-vif-uuid">
1509 The virtual interface associated with this interface.
1512 <column name="external_ids" key="xs-network-uuid">
1513 The virtual network to which this interface is attached.
1516 <column name="external_ids" key="xs-vm-uuid">
1517 The VM to which this interface belongs.
1521 <group title="Common Columns">
1522 The overall purpose of these columns is described under <code>Common
1523 Columns</code> at the beginning of this document.
1525 <column name="other_config"/>
1526 <column name="external_ids"/>
1530 <table name="QoS" title="Quality of Service configuration">
1531 <p>Quality of Service (QoS) configuration for each Port that
1534 <column name="type">
1535 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1536 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1537 identifies the types that a switch actually supports. The currently
1538 defined types are listed below:</p>
1540 <dt><code>linux-htb</code></dt>
1542 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1543 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1544 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1545 for information on how this classifier works and how to configure it.
1549 <dt><code>linux-hfsc</code></dt>
1551 Linux "Hierarchical Fair Service Curve" classifier.
1552 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1553 information on how this classifier works.
1558 <column name="queues">
1559 <p>A map from queue numbers to <ref table="Queue"/> records. The
1560 supported range of queue numbers depend on <ref column="type"/>. The
1561 queue numbers are the same as the <code>queue_id</code> used in
1562 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1563 structures. Queue 0 is used by OpenFlow output actions that do not
1564 specify a specific queue.</p>
1567 <group title="Configuration for linux-htb and linux-hfsc">
1569 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1570 the following key-value pair:
1573 <column name="other_config" key="max-rate">
1574 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
1575 specified, for physical interfaces, the default is the link rate. For
1576 other interfaces or if the link rate cannot be determined, the default
1577 is currently 100 Mbps.
1581 <group title="Common Columns">
1582 The overall purpose of these columns is described under <code>Common
1583 Columns</code> at the beginning of this document.
1585 <column name="other_config"/>
1586 <column name="external_ids"/>
1590 <table name="Queue" title="QoS output queue.">
1591 <p>A configuration for a port output queue, used in configuring Quality of
1592 Service (QoS) features. May be referenced by <ref column="queues"
1593 table="QoS"/> column in <ref table="QoS"/> table.</p>
1595 <group title="Configuration for min-rate QoS">
1597 These key-value pairs are defined for <ref table="QoS"/> <ref
1598 table="QoS" column="type"/> of <code>min-rate</code>.
1601 <column name="other_config" key="min-rate">
1602 Minimum guaranteed bandwidth, in bit/s. Required. The floor value is
1603 1500 bytes/s (12,000 bit/s).
1607 <group title="Configuration for linux-htb QoS">
1609 These key-value pairs are defined for <ref table="QoS"/> <ref
1610 table="QoS" column="type"/> of <code>linux-htb</code>.
1613 <column name="other_config" key="min-rate">
1614 Minimum guaranteed bandwidth, in bit/s.
1617 <column name="other_config" key="max-rate">
1618 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1619 queue's rate will not be allowed to exceed the specified value, even
1620 if excess bandwidth is available. If unspecified, defaults to no
1624 <column name="other_config" key="burst">
1625 Burst size, in bits. This is the maximum amount of ``credits'' that a
1626 queue can accumulate while it is idle. Optional. Details of the
1627 <code>linux-htb</code> implementation require a minimum burst size, so
1628 a too-small <code>burst</code> will be silently ignored.
1631 <column name="other_config" key="priority">
1632 A nonnegative 32-bit integer. Defaults to 0 if unspecified. A queue
1633 with a smaller <code>priority</code> will receive all the excess
1634 bandwidth that it can use before a queue with a larger value receives
1635 any. Specific priority values are unimportant; only relative ordering
1640 <group title="Configuration for linux-hfsc QoS">
1642 These key-value pairs are defined for <ref table="QoS"/> <ref
1643 table="QoS" column="type"/> of <code>linux-hfsc</code>.
1646 <column name="other_config" key="min-rate">
1647 Minimum guaranteed bandwidth, in bit/s.
1650 <column name="other_config" key="max-rate">
1651 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1652 queue's rate will not be allowed to exceed the specified value, even if
1653 excess bandwidth is available. If unspecified, defaults to no
1658 <group title="Common Columns">
1659 The overall purpose of these columns is described under <code>Common
1660 Columns</code> at the beginning of this document.
1662 <column name="other_config"/>
1663 <column name="external_ids"/>
1667 <table name="Mirror" title="Port mirroring (SPAN/RSPAN/ERSPAN).">
1668 <p>A port mirror within a <ref table="Bridge"/>.</p>
1669 <p>A port mirror configures a bridge to send selected frames to special
1670 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1671 traffic may also be referred to as SPAN, RSPAN, or ERSPAN, depending on how
1672 the mirrored traffic is sent.</p>
1674 <column name="name">
1675 Arbitrary identifier for the <ref table="Mirror"/>.
1678 <group title="Selecting Packets for Mirroring">
1680 To be selected for mirroring, a given packet must enter or leave the
1681 bridge through a selected port and it must also be in one of the
1685 <column name="select_all">
1686 If true, every packet arriving or departing on any port is
1687 selected for mirroring.
1690 <column name="select_dst_port">
1691 Ports on which departing packets are selected for mirroring.
1694 <column name="select_src_port">
1695 Ports on which arriving packets are selected for mirroring.
1698 <column name="select_vlan">
1699 VLANs on which packets are selected for mirroring. An empty set
1700 selects packets on all VLANs.
1704 <group title="Mirroring Destination Configuration">
1706 These columns are mutually exclusive. Exactly one of them must be
1710 <column name="output_port">
1711 <p>Output port for selected packets, if nonempty.</p>
1712 <p>Specifying a port for mirror output reserves that port exclusively
1713 for mirroring. No frames other than those selected for mirroring
1714 will be forwarded to the port, and any frames received on the port
1715 will be discarded.</p>
1717 The output port may be any kind of port supported by Open vSwitch.
1718 It may be, for example, a physical port (sometimes called SPAN), or a
1719 GRE tunnel (sometimes called ERSPAN).
1723 <column name="output_vlan">
1724 <p>Output VLAN for selected packets, if nonempty.</p>
1725 <p>The frames will be sent out all ports that trunk
1726 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1727 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1728 trunk port, the frame's VLAN tag will be set to
1729 <ref column="output_vlan"/>, replacing any existing tag; when it is
1730 sent out an implicit VLAN port, the frame will not be tagged. This
1731 type of mirroring is sometimes called RSPAN.</p>
1733 The following destination MAC addresses will not be mirrored to a
1734 VLAN to avoid confusing switches that interpret the protocols that
1738 <dt><code>01:80:c2:00:00:00</code></dt>
1739 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
1741 <dt><code>01:80:c2:00:00:01</code></dt>
1742 <dd>IEEE Pause frame.</dd>
1744 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
1745 <dd>Other reserved protocols.</dd>
1747 <dt><code>01:00:0c:cc:cc:cc</code></dt>
1749 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
1750 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
1754 <dt><code>01:00:0c:cc:cc:cd</code></dt>
1755 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
1757 <dt><code>01:00:0c:cd:cd:cd</code></dt>
1758 <dd>Cisco STP Uplink Fast.</dd>
1760 <dt><code>01:00:0c:00:00:00</code></dt>
1761 <dd>Cisco Inter Switch Link.</dd>
1763 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1764 contains unmanaged switches. Consider an unmanaged physical switch
1765 with two ports: port 1, connected to an end host, and port 2,
1766 connected to an Open vSwitch configured to mirror received packets
1767 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1768 port 1 that the physical switch forwards to port 2. The Open vSwitch
1769 forwards this packet to its destination and then reflects it back on
1770 port 2 in VLAN 123. This reflected packet causes the unmanaged
1771 physical switch to replace the MAC learning table entry, which
1772 correctly pointed to port 1, with one that incorrectly points to port
1773 2. Afterward, the physical switch will direct packets destined for
1774 the end host to the Open vSwitch on port 2, instead of to the end
1775 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1776 desired in this scenario, then the physical switch must be replaced
1777 by one that learns Ethernet addresses on a per-VLAN basis. In
1778 addition, learning should be disabled on the VLAN containing mirrored
1779 traffic. If this is not done then intermediate switches will learn
1780 the MAC address of each end host from the mirrored traffic. If
1781 packets being sent to that end host are also mirrored, then they will
1782 be dropped since the switch will attempt to send them out the input
1783 port. Disabling learning for the VLAN will cause the switch to
1784 correctly send the packet out all ports configured for that VLAN. If
1785 Open vSwitch is being used as an intermediate switch, learning can be
1786 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1787 in the appropriate <ref table="Bridge"/> table or tables.</p>
1789 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
1790 VLAN and should generally be preferred.
1795 <group title="Common Columns">
1796 The overall purpose of these columns is described under <code>Common
1797 Columns</code> at the beginning of this document.
1799 <column name="external_ids"/>
1803 <table name="Controller" title="OpenFlow controller configuration.">
1804 <p>An OpenFlow controller.</p>
1807 Open vSwitch supports two kinds of OpenFlow controllers:
1811 <dt>Primary controllers</dt>
1814 This is the kind of controller envisioned by the OpenFlow 1.0
1815 specification. Usually, a primary controller implements a network
1816 policy by taking charge of the switch's flow table.
1820 Open vSwitch initiates and maintains persistent connections to
1821 primary controllers, retrying the connection each time it fails or
1822 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1823 <ref table="Bridge"/> table applies to primary controllers.
1827 Open vSwitch permits a bridge to have any number of primary
1828 controllers. When multiple controllers are configured, Open
1829 vSwitch connects to all of them simultaneously. Because
1830 OpenFlow 1.0 does not specify how multiple controllers
1831 coordinate in interacting with a single switch, more than
1832 one primary controller should be specified only if the
1833 controllers are themselves designed to coordinate with each
1834 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1835 vendor extension may be useful for this.)
1838 <dt>Service controllers</dt>
1841 These kinds of OpenFlow controller connections are intended for
1842 occasional support and maintenance use, e.g. with
1843 <code>ovs-ofctl</code>. Usually a service controller connects only
1844 briefly to inspect or modify some of a switch's state.
1848 Open vSwitch listens for incoming connections from service
1849 controllers. The service controllers initiate and, if necessary,
1850 maintain the connections from their end. The <ref table="Bridge"
1851 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1852 not apply to service controllers.
1856 Open vSwitch supports configuring any number of service controllers.
1862 The <ref column="target"/> determines the type of controller.
1865 <group title="Core Features">
1866 <column name="target">
1867 <p>Connection method for controller.</p>
1869 The following connection methods are currently supported for primary
1873 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1875 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1876 the given <var>ip</var>, which must be expressed as an IP address
1877 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1878 column in the <ref table="Open_vSwitch"/> table must point to a
1879 valid SSL configuration when this form is used.</p>
1880 <p>SSL support is an optional feature that is not always built as
1881 part of Open vSwitch.</p>
1883 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1884 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1885 the given <var>ip</var>, which must be expressed as an IP address
1886 (not a DNS name).</dd>
1889 The following connection methods are currently supported for service
1893 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1896 Listens for SSL connections on the specified TCP <var>port</var>
1897 (default: 6633). If <var>ip</var>, which must be expressed as an
1898 IP address (not a DNS name), is specified, then connections are
1899 restricted to the specified local IP address.
1902 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1903 table="Open_vSwitch"/> table must point to a valid SSL
1904 configuration when this form is used.
1906 <p>SSL support is an optional feature that is not always built as
1907 part of Open vSwitch.</p>
1909 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1911 Listens for connections on the specified TCP <var>port</var>
1912 (default: 6633). If <var>ip</var>, which must be expressed as an
1913 IP address (not a DNS name), is specified, then connections are
1914 restricted to the specified local IP address.
1917 <p>When multiple controllers are configured for a single bridge, the
1918 <ref column="target"/> values must be unique. Duplicate
1919 <ref column="target"/> values yield unspecified results.</p>
1922 <column name="connection_mode">
1923 <p>If it is specified, this setting must be one of the following
1924 strings that describes how Open vSwitch contacts this OpenFlow
1925 controller over the network:</p>
1928 <dt><code>in-band</code></dt>
1929 <dd>In this mode, this controller's OpenFlow traffic travels over the
1930 bridge associated with the controller. With this setting, Open
1931 vSwitch allows traffic to and from the controller regardless of the
1932 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1933 would never be able to connect to the controller, because it did
1934 not have a flow to enable it.) This is the most common connection
1935 mode because it is not necessary to maintain two independent
1937 <dt><code>out-of-band</code></dt>
1938 <dd>In this mode, OpenFlow traffic uses a control network separate
1939 from the bridge associated with this controller, that is, the
1940 bridge does not use any of its own network devices to communicate
1941 with the controller. The control network must be configured
1942 separately, before or after <code>ovs-vswitchd</code> is started.
1946 <p>If not specified, the default is implementation-specific.</p>
1950 <group title="Controller Failure Detection and Handling">
1951 <column name="max_backoff">
1952 Maximum number of milliseconds to wait between connection attempts.
1953 Default is implementation-specific.
1956 <column name="inactivity_probe">
1957 Maximum number of milliseconds of idle time on connection to
1958 controller before sending an inactivity probe message. If Open
1959 vSwitch does not communicate with the controller for the specified
1960 number of seconds, it will send a probe. If a response is not
1961 received for the same additional amount of time, Open vSwitch
1962 assumes the connection has been broken and attempts to reconnect.
1963 Default is implementation-specific. A value of 0 disables
1968 <group title="OpenFlow Rate Limiting">
1969 <column name="controller_rate_limit">
1970 <p>The maximum rate at which packets in unknown flows will be
1971 forwarded to the OpenFlow controller, in packets per second. This
1972 feature prevents a single bridge from overwhelming the controller.
1973 If not specified, the default is implementation-specific.</p>
1974 <p>In addition, when a high rate triggers rate-limiting, Open
1975 vSwitch queues controller packets for each port and transmits
1976 them to the controller at the configured rate. The number of
1977 queued packets is limited by
1978 the <ref column="controller_burst_limit"/> value. The packet
1979 queue is shared fairly among the ports on a bridge.</p><p>Open
1980 vSwitch maintains two such packet rate-limiters per bridge.
1981 One of these applies to packets sent up to the controller
1982 because they do not correspond to any flow. The other applies
1983 to packets sent up to the controller by request through flow
1984 actions. When both rate-limiters are filled with packets, the
1985 actual rate that packets are sent to the controller is up to
1986 twice the specified rate.</p>
1989 <column name="controller_burst_limit">
1990 In conjunction with <ref column="controller_rate_limit"/>,
1991 the maximum number of unused packet credits that the bridge will
1992 allow to accumulate, in packets. If not specified, the default
1993 is implementation-specific.
1997 <group title="Additional In-Band Configuration">
1998 <p>These values are considered only in in-band control mode (see
1999 <ref column="connection_mode"/>).</p>
2001 <p>When multiple controllers are configured on a single bridge, there
2002 should be only one set of unique values in these columns. If different
2003 values are set for these columns in different controllers, the effect
2006 <column name="local_ip">
2007 The IP address to configure on the local port,
2008 e.g. <code>192.168.0.123</code>. If this value is unset, then
2009 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2013 <column name="local_netmask">
2014 The IP netmask to configure on the local port,
2015 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2016 but this value is unset, then the default is chosen based on whether
2017 the IP address is class A, B, or C.
2020 <column name="local_gateway">
2021 The IP address of the gateway to configure on the local port, as a
2022 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2023 this network has no gateway.
2027 <group title="Controller Status">
2028 <column name="is_connected">
2029 <code>true</code> if currently connected to this controller,
2030 <code>false</code> otherwise.
2033 <column name="role">
2034 <p>The level of authority this controller has on the associated
2035 bridge. Possible values are:</p>
2037 <dt><code>other</code></dt>
2038 <dd>Allows the controller access to all OpenFlow features.</dd>
2039 <dt><code>master</code></dt>
2040 <dd>Equivalent to <code>other</code>, except that there may be at
2041 most one master controller at a time. When a controller configures
2042 itself as <code>master</code>, any existing master is demoted to
2043 the <code>slave</code>role.</dd>
2044 <dt><code>slave</code></dt>
2045 <dd>Allows the controller read-only access to OpenFlow features.
2046 Attempts to modify the flow table will be rejected with an
2047 error. Slave controllers do not receive OFPT_PACKET_IN or
2048 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2053 <column name="status" key="last_error">
2054 A human-readable description of the last error on the connection
2055 to the controller; i.e. <code>strerror(errno)</code>. This key
2056 will exist only if an error has occurred.
2059 <column name="status" key="state">
2061 The state of the connection to the controller. Possible values are:
2064 <dt><code>VOID</code></dt>
2065 <dd>Connection is disabled.</dd>
2067 <dt><code>BACKOFF</code></dt>
2068 <dd>Attempting to reconnect at an increasing period.</dd>
2070 <dt><code>CONNECTING</code></dt>
2071 <dd>Attempting to connect.</dd>
2073 <dt><code>ACTIVE</code></dt>
2074 <dd>Connected, remote host responsive.</dd>
2076 <dt><code>IDLE</code></dt>
2077 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2080 These values may change in the future. They are provided only for
2085 <column name="status" key="sec_since_connect">
2086 The amount of time since this controller last successfully connected to
2087 the switch (in seconds). Value is empty if controller has never
2088 successfully connected.
2091 <column name="status" key="sec_since_disconnect">
2092 The amount of time since this controller last disconnected from
2093 the switch (in seconds). Value is empty if controller has never
2098 <group title="Common Columns">
2099 The overall purpose of these columns is described under <code>Common
2100 Columns</code> at the beginning of this document.
2102 <column name="external_ids"/>
2106 <table name="Manager" title="OVSDB management connection.">
2108 Configuration for a database connection to an Open vSwitch database
2113 This table primarily configures the Open vSwitch database
2114 (<code>ovsdb-server</code>), not the Open vSwitch switch
2115 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2116 what connections should be treated as in-band.
2120 The Open vSwitch database server can initiate and maintain active
2121 connections to remote clients. It can also listen for database
2125 <group title="Core Features">
2126 <column name="target">
2127 <p>Connection method for managers.</p>
2129 The following connection methods are currently supported:
2132 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2135 The specified SSL <var>port</var> (default: 6632) on the host at
2136 the given <var>ip</var>, which must be expressed as an IP address
2137 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2138 column in the <ref table="Open_vSwitch"/> table must point to a
2139 valid SSL configuration when this form is used.
2142 SSL support is an optional feature that is not always built as
2143 part of Open vSwitch.
2147 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2149 The specified TCP <var>port</var> (default: 6632) on the host at
2150 the given <var>ip</var>, which must be expressed as an IP address
2153 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2156 Listens for SSL connections on the specified TCP <var>port</var>
2157 (default: 6632). If <var>ip</var>, which must be expressed as an
2158 IP address (not a DNS name), is specified, then connections are
2159 restricted to the specified local IP address.
2162 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2163 table="Open_vSwitch"/> table must point to a valid SSL
2164 configuration when this form is used.
2167 SSL support is an optional feature that is not always built as
2168 part of Open vSwitch.
2171 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2173 Listens for connections on the specified TCP <var>port</var>
2174 (default: 6632). If <var>ip</var>, which must be expressed as an
2175 IP address (not a DNS name), is specified, then connections are
2176 restricted to the specified local IP address.
2179 <p>When multiple managers are configured, the <ref column="target"/>
2180 values must be unique. Duplicate <ref column="target"/> values yield
2181 unspecified results.</p>
2184 <column name="connection_mode">
2186 If it is specified, this setting must be one of the following strings
2187 that describes how Open vSwitch contacts this OVSDB client over the
2192 <dt><code>in-band</code></dt>
2194 In this mode, this connection's traffic travels over a bridge
2195 managed by Open vSwitch. With this setting, Open vSwitch allows
2196 traffic to and from the client regardless of the contents of the
2197 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2198 to connect to the client, because it did not have a flow to enable
2199 it.) This is the most common connection mode because it is not
2200 necessary to maintain two independent networks.
2202 <dt><code>out-of-band</code></dt>
2204 In this mode, the client's traffic uses a control network separate
2205 from that managed by Open vSwitch, that is, Open vSwitch does not
2206 use any of its own network devices to communicate with the client.
2207 The control network must be configured separately, before or after
2208 <code>ovs-vswitchd</code> is started.
2213 If not specified, the default is implementation-specific.
2218 <group title="Client Failure Detection and Handling">
2219 <column name="max_backoff">
2220 Maximum number of milliseconds to wait between connection attempts.
2221 Default is implementation-specific.
2224 <column name="inactivity_probe">
2225 Maximum number of milliseconds of idle time on connection to the client
2226 before sending an inactivity probe message. If Open vSwitch does not
2227 communicate with the client for the specified number of seconds, it
2228 will send a probe. If a response is not received for the same
2229 additional amount of time, Open vSwitch assumes the connection has been
2230 broken and attempts to reconnect. Default is implementation-specific.
2231 A value of 0 disables inactivity probes.
2235 <group title="Status">
2236 <column name="is_connected">
2237 <code>true</code> if currently connected to this manager,
2238 <code>false</code> otherwise.
2241 <column name="status" key="last_error">
2242 A human-readable description of the last error on the connection
2243 to the manager; i.e. <code>strerror(errno)</code>. This key
2244 will exist only if an error has occurred.
2247 <column name="status" key="state">
2249 The state of the connection to the manager. Possible values are:
2252 <dt><code>VOID</code></dt>
2253 <dd>Connection is disabled.</dd>
2255 <dt><code>BACKOFF</code></dt>
2256 <dd>Attempting to reconnect at an increasing period.</dd>
2258 <dt><code>CONNECTING</code></dt>
2259 <dd>Attempting to connect.</dd>
2261 <dt><code>ACTIVE</code></dt>
2262 <dd>Connected, remote host responsive.</dd>
2264 <dt><code>IDLE</code></dt>
2265 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2268 These values may change in the future. They are provided only for
2273 <column name="status" key="sec_since_connect">
2274 The amount of time since this manager last successfully connected
2275 to the database (in seconds). Value is empty if manager has never
2276 successfully connected.
2279 <column name="status" key="sec_since_disconnect">
2280 The amount of time since this manager last disconnected from the
2281 database (in seconds). Value is empty if manager has never
2285 <column name="status" key="locks_held">
2286 Space-separated list of the names of OVSDB locks that the connection
2287 holds. Omitted if the connection does not hold any locks.
2290 <column name="status" key="locks_waiting">
2291 Space-separated list of the names of OVSDB locks that the connection is
2292 currently waiting to acquire. Omitted if the connection is not waiting
2296 <column name="status" key="locks_lost">
2297 Space-separated list of the names of OVSDB locks that the connection
2298 has had stolen by another OVSDB client. Omitted if no locks have been
2299 stolen from this connection.
2302 <column name="status" key="n_connections">
2304 When <ref column="target"/> specifies a connection method that
2305 listens for inbound connections (e.g. <code>ptcp:</code> or
2306 <code>pssl:</code>) and more than one connection is actually active,
2307 the value is the number of active connections. Otherwise, this
2308 key-value pair is omitted.
2311 When multiple connections are active, status columns and key-value
2312 pairs (other than this one) report the status of one arbitrarily
2318 <group title="Common Columns">
2319 The overall purpose of these columns is described under <code>Common
2320 Columns</code> at the beginning of this document.
2322 <column name="external_ids"/>
2326 <table name="NetFlow">
2327 A NetFlow target. NetFlow is a protocol that exports a number of
2328 details about terminating IP flows, such as the principals involved
2331 <column name="targets">
2332 NetFlow targets in the form
2333 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2334 must be specified numerically, not as a DNS name.
2337 <column name="engine_id">
2338 Engine ID to use in NetFlow messages. Defaults to datapath index
2342 <column name="engine_type">
2343 Engine type to use in NetFlow messages. Defaults to datapath
2344 index if not specified.
2347 <column name="active_timeout">
2348 The interval at which NetFlow records are sent for flows that are
2349 still active, in seconds. A value of <code>0</code> requests the
2350 default timeout (currently 600 seconds); a value of <code>-1</code>
2351 disables active timeouts.
2354 <column name="add_id_to_interface">
2355 <p>If this column's value is <code>false</code>, the ingress and egress
2356 interface fields of NetFlow flow records are derived from OpenFlow port
2357 numbers. When it is <code>true</code>, the 7 most significant bits of
2358 these fields will be replaced by the least significant 7 bits of the
2359 engine id. This is useful because many NetFlow collectors do not
2360 expect multiple switches to be sending messages from the same host, so
2361 they do not store the engine information which could be used to
2362 disambiguate the traffic.</p>
2363 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2366 <group title="Common Columns">
2367 The overall purpose of these columns is described under <code>Common
2368 Columns</code> at the beginning of this document.
2370 <column name="external_ids"/>
2375 SSL configuration for an Open_vSwitch.
2377 <column name="private_key">
2378 Name of a PEM file containing the private key used as the switch's
2379 identity for SSL connections to the controller.
2382 <column name="certificate">
2383 Name of a PEM file containing a certificate, signed by the
2384 certificate authority (CA) used by the controller and manager,
2385 that certifies the switch's private key, identifying a trustworthy
2389 <column name="ca_cert">
2390 Name of a PEM file containing the CA certificate used to verify
2391 that the switch is connected to a trustworthy controller.
2394 <column name="bootstrap_ca_cert">
2395 If set to <code>true</code>, then Open vSwitch will attempt to
2396 obtain the CA certificate from the controller on its first SSL
2397 connection and save it to the named PEM file. If it is successful,
2398 it will immediately drop the connection and reconnect, and from then
2399 on all SSL connections must be authenticated by a certificate signed
2400 by the CA certificate thus obtained. <em>This option exposes the
2401 SSL connection to a man-in-the-middle attack obtaining the initial
2402 CA certificate.</em> It may still be useful for bootstrapping.
2405 <group title="Common Columns">
2406 The overall purpose of these columns is described under <code>Common
2407 Columns</code> at the beginning of this document.
2409 <column name="external_ids"/>
2413 <table name="sFlow">
2414 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2417 <column name="agent">
2418 Name of the network device whose IP address should be reported as the
2419 ``agent address'' to collectors. If not specified, the IP address
2420 defaults to the <ref table="Controller" column="local_ip"/> in the
2421 collector's <ref table="Controller"/>. If an agent IP address cannot be
2422 determined either way, sFlow is disabled.
2425 <column name="header">
2426 Number of bytes of a sampled packet to send to the collector.
2427 If not specified, the default is 128 bytes.
2430 <column name="polling">
2431 Polling rate in seconds to send port statistics to the collector.
2432 If not specified, defaults to 30 seconds.
2435 <column name="sampling">
2436 Rate at which packets should be sampled and sent to the collector.
2437 If not specified, defaults to 400, which means one out of 400
2438 packets, on average, will be sent to the collector.
2441 <column name="targets">
2442 sFlow targets in the form
2443 <code><var>ip</var>:<var>port</var></code>.
2446 <group title="Common Columns">
2447 The overall purpose of these columns is described under <code>Common
2448 Columns</code> at the beginning of this document.
2450 <column name="external_ids"/>
2454 <table name="Capability">
2455 <p>Records in this table describe functionality supported by the hardware
2456 and software platform on which this Open vSwitch is based. Clients
2457 should not modify this table.</p>
2459 <p>A record in this table is meaningful only if it is referenced by the
2460 <ref table="Open_vSwitch" column="capabilities"/> column in the
2461 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2462 the record's ``category,'' determines the meanings of the
2463 <ref column="details"/> column. The following general forms of
2464 categories are currently defined:</p>
2467 <dt><code>qos-<var>type</var></code></dt>
2468 <dd><var>type</var> is supported as the value for
2469 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2473 <column name="details">
2474 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2475 depends on the category key that the <ref table="Open_vSwitch"
2476 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2477 uses to reference this record, as described above.</p>
2479 <p>The presence of a record for category <code>qos-<var>type</var></code>
2480 indicates that the switch supports <var>type</var> as the value of
2481 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2482 table. The following key-value pairs are defined to further describe
2483 QoS capabilities:</p>
2486 <dt><code>n-queues</code></dt>
2487 <dd>Number of supported queues, as a positive integer. Keys in the
2488 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2489 records whose <ref table="QoS" column="type"/> value
2490 equals <var>type</var> must range between 0 and this value minus one,