1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
3 <p>A database with this schema holds the configuration for one Open
4 vSwitch daemon. The root of the configuration for the daemon is
5 the <ref table="Open_vSwitch"/> table, which must have exactly one
6 record. Records in other tables are significant only when they
7 can be reached directly or indirectly from the
8 <ref table="Open_vSwitch"/> table.</p>
10 <table name="Open_vSwitch" title="Open vSwitch configuration.">
11 Configuration for an Open vSwitch daemon. There must be exactly one record
12 in the <ref table="Open_vSwitch"/> table.
14 <group title="Configuration">
15 <column name="bridges">
16 Set of bridges managed by the daemon.
20 SSL used globally by the daemon.
23 <column name="external_ids">
24 Key-value pairs for use by external frameworks that integrate
25 with Open vSwitch, rather than by Open vSwitch itself. System
26 integrators should either use the Open vSwitch development
27 mailing list to coordinate on common key-value definitions, or
28 choose key names that are likely to be unique. The currently
29 defined common key-value pairs are:
31 <dt><code>system-id</code></dt>
32 <dd>A unique identifier for the Open vSwitch's physical host.
33 The form of the identifier depends on the type of the host.
34 On a Citrix XenServer, this will likely be the same as
35 <code>xs-system-uuid</code>.</dd>
36 <dt><code>xs-system-uuid</code></dt>
37 <dd>The Citrix XenServer universally unique identifier for the
38 physical host as displayed by <code>xe host-list</code>.</dd>
43 <group title="Status">
44 <column name="next_cfg">
45 Sequence number for client to increment. When a client modifies
46 any part of the database configuration and wishes to wait for
47 Open vSwitch to finish applying the changes, it may increment
51 <column name="cur_cfg">
52 Sequence number that Open vSwitch sets to the current value of
53 <ref column="next_cfg"/> after it finishes applying a set of
54 configuration changes.
57 <column name="capabilities">
58 Describes functionality supported by the hardware and software platform
59 on which this Open vSwitch is based. Clients should not modify this
60 column. See the <ref table="Capability"/> description for defined
61 capability categories and the meaning of associated
62 <ref table="Capability"/> records.
65 <column name="statistics">
67 Key-value pairs that report statistics about a system running an Open
68 vSwitch. These are updated periodically (currently, every 5
69 seconds). Key-value pairs that cannot be determined or that do not
70 apply to a platform are omitted.
74 <dt><code>cpu</code></dt>
77 Number of CPU processors, threads, or cores currently online and
78 available to the operating system on which Open vSwitch is
79 running, as an integer. This may be less than the number
80 installed, if some are not online or if they are not available to
84 Open vSwitch userspace processes are not multithreaded, but the
85 Linux kernel-based datapath is.
89 <dt><code>load_average</code></dt>
92 A comma-separated list of three floating-point numbers,
93 representing the system load average over the last 1, 5, and 15
94 minutes, respectively.
98 <dt><code>memory</code></dt>
101 A comma-separated list of integers, each of which represents a
102 quantity of memory in kilobytes that describes the operating
103 system on which Open vSwitch is running. In respective order,
108 <li>Total amount of RAM allocated to the OS.</li>
109 <li>RAM allocated to the OS that is in use.</li>
110 <li>RAM that can be flushed out to disk or otherwise discarded
111 if that space is needed for another purpose. This number is
112 necessarily less than or equal to the previous value.</li>
113 <li>Total disk space allocated for swap.</li>
114 <li>Swap space currently in use.</li>
118 On Linux, all five values can be determined and are included. On
119 other operating systems, only the first two values can be
120 determined, so the list will only have two values.
124 <dt><code>process_</code><var>name</var></dt>
127 One such key-value pair will exist for each running Open vSwitch
128 daemon process, with <var>name</var> replaced by the daemon's
129 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
130 comma-separated list of integers. The integers represent the
131 following, with memory measured in kilobytes and durations in
136 <li>The process's virtual memory size.</li>
137 <li>The process's resident set size.</li>
138 <li>The amount of user and system CPU time consumed by the
140 <li>The number of times that the process has crashed and been
141 automatically restarted by the monitor.</li>
142 <li>The duration since the process was started.</li>
143 <li>The duration for which the process has been running.</li>
147 The interpretation of some of these values depends on whether the
148 process was started with the <option>--monitor</option>. If it
149 was not, then the crash count will always be 0 and the two
150 durations will always be the same. If <option>--monitor</option>
151 was given, then the crash count may be positive; if it is, the
152 latter duration is the amount of time since the most recent crash
157 There will be one key-value pair for each file in Open vSwitch's
158 ``run directory'' (usually <code>/var/run/openvswitch</code>)
159 whose name ends in <code>.pid</code>, whose contents are a
160 process ID, and which is locked by a running process. The
161 <var>name</var> is taken from the pidfile's name.
165 Currently Open vSwitch is only able to obtain all of the above
166 detail on Linux systems. On other systems, the same key-value
167 pairs will be present but the values will always be the empty
172 <dt><code>file_systems</code></dt>
175 A space-separated list of information on local, writable file
176 systems. Each item in the list describes one file system and
177 consists in turn of a comma-separated list of the following:
181 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
182 Any spaces or commas in the mount point are replaced by
184 <li>Total size, in kilobytes, as an integer.</li>
185 <li>Amount of storage in use, in kilobytes, as an integer.</li>
189 This key-value pair is omitted if there are no local, writable
190 file systems or if Open vSwitch cannot obtain the needed
198 <group title="Version Reporting">
200 These columns report the types and versions of the hardware and
201 software running Open vSwitch. We recommend in general that software
202 should test whether specific features are supported instead of relying
203 on version number checks. These values are primarily intended for
204 reporting to human administrators.
207 <column name="ovs_version">
208 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
209 If Open vSwitch was configured with a build number, then it is
210 also included, e.g. <code>1.1.0pre2+build4948</code>.
213 <column name="db_version">
215 The database schema version number in the form
216 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
217 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
218 a non-backward compatible way (e.g. deleting a column or a table),
219 <var>major</var> is incremented. When the database schema is changed
220 in a backward compatible way (e.g. adding a new column),
221 <var>minor</var> is incremented. When the database schema is changed
222 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
227 The schema version is part of the database schema, so it can also be
228 retrieved by fetching the schema using the Open vSwitch database
233 <column name="system_type">
235 An identifier for the type of system on top of which Open vSwitch
236 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
239 System integrators are responsible for choosing and setting an
240 appropriate value for this column.
244 <column name="system_version">
246 The version of the system identified by <ref column="system_type"/>,
247 e.g. <code>5.5.0-24648p</code> on XenServer 5.5.0 build 24648.
250 System integrators are responsible for choosing and setting an
251 appropriate value for this column.
257 <group title="Database Configuration">
259 These columns primarily configure the Open vSwitch database
260 (<code>ovsdb-server</code>), not the Open vSwitch switch
261 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
262 column="ssl"/> settings.
266 The Open vSwitch switch does read the database configuration to
267 determine remote IP addresses to which in-band control should apply.
270 <column name="manager_options">
271 Database clients to which the Open vSwitch database server should
272 connect or to which it should listen, along with options for how these
273 connection should be configured. See the <ref table="Manager"/> table
274 for more information.
277 <column name="managers">
279 Remote database clients to which the Open vSwitch's database server
280 should connect or to which it should listen. Adding an OVSDB target
281 to this set is equivalent to adding it to <ref
282 column="manager_options"/> with all of the default options.
286 Use of this column is deprecated and may be removed sometime in the
287 future. New applications should use and set <ref
288 column="manager_options"/> instead.
294 <table name="Bridge">
296 Configuration for a bridge within an
297 <ref table="Open_vSwitch"/>.
300 A <ref table="Bridge"/> record represents an Ethernet switch with one or
301 more ``ports,'' which are the <ref table="Port"/> records pointed to by
302 the <ref table="Bridge"/>'s <ref column="ports"/> column.
305 <group title="Core Features">
307 Bridge identifier. Should be alphanumeric and no more than about 8
308 bytes long. Must be unique among the names of ports, interfaces, and
312 <column name="ports">
313 Ports included in the bridge.
316 <column name="mirrors">
317 Port mirroring configuration.
320 <column name="netflow">
321 NetFlow configuration.
324 <column name="sflow">
328 <column name="flood_vlans">
329 VLAN IDs of VLANs on which MAC address learning should be disabled, so
330 that packets are flooded instead of being sent to specific ports that
331 are believed to contain packets' destination MACs. This should
332 ordinarily be used to disable MAC learning on VLANs used for mirroring
333 (RSPAN VLANs). It may also be useful for debugging.
337 <group title="OpenFlow Configuration">
338 <column name="controller">
339 OpenFlow controller set. If unset, then no OpenFlow controllers
343 <column name="fail_mode">
344 <p>When a controller is configured, it is, ordinarily, responsible
345 for setting up all flows on the switch. Thus, if the connection to
346 the controller fails, no new network connections can be set up.
347 If the connection to the controller stays down long enough,
348 no packets can pass through the switch at all. This setting
349 determines the switch's response to such a situation. It may be set
350 to one of the following:
352 <dt><code>standalone</code></dt>
353 <dd>If no message is received from the controller for three
354 times the inactivity probe interval
355 (see <ref column="inactivity_probe"/>), then Open vSwitch
356 will take over responsibility for setting up flows. In
357 this mode, Open vSwitch causes the bridge to act like an
358 ordinary MAC-learning switch. Open vSwitch will continue
359 to retry connecting to the controller in the background
360 and, when the connection succeeds, it will discontinue its
361 standalone behavior.</dd>
362 <dt><code>secure</code></dt>
363 <dd>Open vSwitch will not set up flows on its own when the
364 controller connection fails or when no controllers are
365 defined. The bridge will continue to retry connecting to
366 any defined controllers forever.</dd>
369 <p>If this value is unset, the default is implementation-specific.</p>
370 <p>When more than one controller is configured,
371 <ref column="fail_mode"/> is considered only when none of the
372 configured controllers can be contacted.</p>
375 <column name="datapath_id">
376 Reports the OpenFlow datapath ID in use. Exactly 16 hex
377 digits. (Setting this column will have no useful effect. Set
378 <ref column="other_config"/>:<code>other-config</code>
383 <group title="Other Features">
384 <column name="datapath_type">
385 Name of datapath provider. The kernel datapath has
386 type <code>system</code>. The userspace datapath has
387 type <code>netdev</code>.
390 <column name="external_ids">
391 Key-value pairs for use by external frameworks that integrate
392 with Open vSwitch, rather than by Open vSwitch itself. System
393 integrators should either use the Open vSwitch development
394 mailing list to coordinate on common key-value definitions, or
395 choose key names that are likely to be unique. The currently
396 defined key-value pairs are:
398 <dt><code>bridge-id</code></dt>
399 <dd>A unique identifier of the bridge. On Citrix XenServer this
400 will commonly be the same as <code>xs-network-uuids</code>.</dd>
401 <dt><code>xs-network-uuids</code></dt>
402 <dd>Semicolon-delimited set of universally unique identifier(s) for
403 the network with which this bridge is associated on a Citrix
404 XenServer host. The network identifiers are RFC 4122 UUIDs as
405 displayed by, e.g., <code>xe network-list</code>.</dd>
409 <column name="other_config">
410 Key-value pairs for configuring rarely used bridge
411 features. The currently defined key-value pairs are:
413 <dt><code>datapath-id</code></dt>
415 digits to set the OpenFlow datapath ID to a specific
416 value. May not be all-zero.</dd>
417 <dt><code>disable-in-band</code></dt>
418 <dd>If set to <code>true</code>, disable in-band control on
419 the bridge regardless of controller and manager settings.</dd>
420 <dt><code>hwaddr</code></dt>
421 <dd>An Ethernet address in the form
422 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
423 to set the hardware address of the local port and influence the
425 <dt><code>in-band-queue</code></dt>
427 A queue ID as a nonnegative integer. This sets the OpenFlow queue
428 ID that will be used by flows set up by in-band control on this
429 bridge. If unset, or if the port used by an in-band control flow
430 does not have QoS configured, or if the port does not have a queue
431 with the specified ID, the default queue is used instead.
438 <table name="Port" table="Port or bond configuration.">
439 <p>A port within a <ref table="Bridge"/>.</p>
440 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
441 <ref column="interfaces"/> column. Such a port logically
442 corresponds to a port on a physical Ethernet switch. A port
443 with more than one interface is a ``bonded port'' (see
444 <ref group="Bonding Configuration"/>).</p>
445 <p>Some properties that one might think as belonging to a port are actually
446 part of the port's <ref table="Interface"/> members.</p>
449 Port name. Should be alphanumeric and no more than about 8
450 bytes long. May be the same as the interface name, for
451 non-bonded ports. Must otherwise be unique among the names of
452 ports, interfaces, and bridges on a host.
455 <column name="interfaces">
456 The port's interfaces. If there is more than one, this is a
460 <group title="VLAN Configuration">
461 <p>A bridge port must be configured for VLANs in one of two
462 mutually exclusive ways:
464 <li>A ``trunk port'' has an empty value for <ref
465 column="tag"/>. Its <ref column="trunks"/> value may be
466 empty or non-empty.</li>
467 <li>An ``implicitly tagged VLAN port'' or ``access port''
468 has an nonempty value for <ref column="tag"/>. Its
469 <ref column="trunks"/> value must be empty.</li>
471 If <ref column="trunks"/> and <ref column="tag"/> are both
472 nonempty, the configuration is ill-formed.
477 If this is an access port (see above), the port's implicitly
478 tagged VLAN. Must be empty if this is a trunk port.
481 Frames arriving on trunk ports will be forwarded to this
482 port only if they are tagged with the given VLAN (or, if
483 <ref column="tag"/> is 0, then if they lack a VLAN header).
484 Frames arriving on other access ports will be forwarded to
485 this port only if they have the same <ref column="tag"/>
486 value. Frames forwarded to this port will not have an
490 When a frame with a 802.1Q header that indicates a nonzero
491 VLAN is received on an access port, it is discarded.
495 <column name="trunks">
497 If this is a trunk port (see above), the 802.1Q VLAN(s) that
498 this port trunks; if it is empty, then the port trunks all
499 VLANs. Must be empty if this is an access port.
502 Frames arriving on trunk ports are dropped if they are not
503 in one of the specified VLANs. For this purpose, packets
504 that have no VLAN header are treated as part of VLAN 0.
509 <group title="Bonding Configuration">
510 <p>A port that has more than one interface is a ``bonded port.'' Bonding
511 allows for load balancing and fail-over. Open vSwitch supports
512 ``source load balancing'' (SLB) and "active backup" bonding. SLB
513 bonding assigns flows to slaves based on source MAC address and output
514 VLAN, with periodic rebalancing as traffic patterns change. Active
515 backup bonding assigns all flows to one slave, failing over to a backup
516 slave when the active slave is disabled. Neither form of bonding
517 require 802.3ad or other special support from the upstream switch to
518 which the slave devices are connected.</p>
520 <p>These columns apply only to bonded ports. Their values are
521 otherwise ignored.</p>
523 <column name="bond_mode">
524 <p>The type of bonding used for a bonded port. Currently supported
525 values are <code>balance-slb</code> and <code>active-backup</code>.
526 Defaults to SLB if unset.</p>
529 <column name="bond_updelay">
530 <p>For a bonded port, the number of milliseconds for which carrier must
531 stay up on an interface before the interface is considered to be up.
532 Specify <code>0</code> to enable the interface immediately.</p>
533 <p>This setting is honored only when at least one bonded interface is
534 already enabled. When no interfaces are enabled, then the first bond
535 interface to come up is enabled immediately.</p>
538 <column name="bond_downdelay">
539 For a bonded port, the number of milliseconds for which carrier must
540 stay down on an interface before the interface is considered to be
541 down. Specify <code>0</code> to disable the interface immediately.
544 <column name="bond_fake_iface">
545 For a bonded port, whether to create a fake internal interface with the
546 name of the port. Use only for compatibility with legacy software that
551 <p>Configures LACP on this port. LACP allows directly connected
552 switches to negotiate which links may be bonded. LACP may be enabled
553 on non-bonded ports for the benefit of any switches they may be
554 connected to. <code>active</code> ports are allowed to initiate LACP
555 negotiations. <code>passive</code> ports are allowed to participate
556 in LACP negotiations initiated by a remote switch, but not allowed to
557 initiate such negotiations themselves. If unset Open vSwitch will
558 choose a reasonable default. </p>
563 <group title="Other Features">
565 Quality of Service configuration for this port.
569 The MAC address to use for this port for the purpose of choosing the
570 bridge's MAC address. This column does not necessarily reflect the
571 port's actual MAC address, nor will setting it change the port's actual
575 <column name="fake_bridge">
576 Does this port represent a sub-bridge for its tagged VLAN within the
577 Bridge? See ovs-vsctl(8) for more information.
580 <column name="external_ids">
582 Key-value pairs for use by external frameworks that integrate with
583 Open vSwitch, rather than by Open vSwitch itself. System integrators
584 should either use the Open vSwitch development mailing list to
585 coordinate on common key-value definitions, or choose key names that
586 are likely to be unique.
589 No key-value pairs native to <ref table="Port"/> are currently
590 defined. For fake bridges (see the <ref column="fake_bridge"/>
591 column), external IDs for the fake bridge are defined here by
592 prefixing a <ref table="Bridge"/> <ref table="Bridge"
593 column="external_ids"/> key with <code>fake-bridge-</code>,
594 e.g. <code>fake-bridge-xs-network-uuids</code>.
598 <column name="other_config">
599 Key-value pairs for configuring rarely used port features. The
600 currently defined key-value pairs are:
602 <dt><code>hwaddr</code></dt>
603 <dd>An Ethernet address in the form
604 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
605 <dt><code>bond-rebalance-interval</code></dt>
606 <dd>For an SLB bonded port, the number of milliseconds between
607 successive attempts to rebalance the bond, that is, to
608 move source MACs and their flows from one interface on
609 the bond to another in an attempt to keep usage of each
610 interface roughly equal. The default is 10000 (10
611 seconds), and the minimum is 1000 (1 second).</dd>
612 <dt><code>bond-detect-mode</code></dt>
613 <dd> Sets the method used to detect link failures in a bonded port.
614 Options are <code>carrier</code> and <code>miimon</code>. Defaults
615 to <code>carrier</code> which uses each interface's carrier to detect
616 failures. When set to <code>miimon</code>, will check for failures
617 by polling each interface's MII. </dd>
618 <dt><code>bond-miimon-interval</code></dt>
619 <dd> The number of milliseconds between successive attempts to
620 poll each interface's MII. Only relevant on ports which use
621 <code>miimon</code> to detect failures. </dd>
622 <dt><code>lacp-system-priority</code></dt>
623 <dd> The LACP system priority of this <ref table="Port"/>. In
624 LACP negotiations, link status decisions are made by the system
625 with the numerically lower priority. Must be a number between 1
632 <table name="Interface" title="One physical network device in a Port.">
633 An interface within a <ref table="Port"/>.
635 <group title="Core Features">
637 Interface name. Should be alphanumeric and no more than about 8 bytes
638 long. May be the same as the port name, for non-bonded ports. Must
639 otherwise be unique among the names of ports, interfaces, and bridges
644 <p>Ethernet address to set for this interface. If unset then the
645 default MAC address is used:</p>
647 <li>For the local interface, the default is the lowest-numbered MAC
648 address among the other bridge ports, either the value of the
649 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
650 if set, or its actual MAC (for bonded ports, the MAC of its slave
651 whose name is first in alphabetical order). Internal ports and
652 bridge ports that are used as port mirroring destinations (see the
653 <ref table="Mirror"/> table) are ignored.</li>
654 <li>For other internal interfaces, the default MAC is randomly
656 <li>External interfaces typically have a MAC address associated with
659 <p>Some interfaces may not have a software-controllable MAC
663 <column name="ofport">
664 <p>OpenFlow port number for this interface. Unlike most columns, this
665 column's value should be set only by Open vSwitch itself. Other
666 clients should set this column to an empty set (the default) when
667 creating an <ref table="Interface"/>.</p>
668 <p>Open vSwitch populates this column when the port number becomes
669 known. If the interface is successfully added,
670 <ref column="ofport"/> will be set to a number between 1 and 65535
671 (generally either in the range 1 to 65279, inclusive, or 65534, the
672 port number for the OpenFlow ``local port''). If the interface
673 cannot be added then Open vSwitch sets this column
678 <group title="System-Specific Details">
680 The interface type, one of:
682 <dt><code>system</code></dt>
683 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
684 Sometimes referred to as ``external interfaces'' since they are
685 generally connected to hardware external to that on which the Open
686 vSwitch is running. The empty string is a synonym for
687 <code>system</code>.</dd>
688 <dt><code>internal</code></dt>
689 <dd>A simulated network device that sends and receives traffic. An
690 internal interface whose <ref column="name"/> is the same as its
691 bridge's <ref table="Open_vSwitch" column="name"/> is called the
692 ``local interface.'' It does not make sense to bond an internal
693 interface, so the terms ``port'' and ``interface'' are often used
694 imprecisely for internal interfaces.</dd>
695 <dt><code>tap</code></dt>
696 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
697 <dt><code>gre</code></dt>
698 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
699 tunnel. Each tunnel must be uniquely identified by the
700 combination of <code>remote_ip</code>, <code>local_ip</code>, and
701 <code>in_key</code>. Note that if two ports are defined that are
702 the same except one has an optional identifier and the other does
703 not, the more specific one is matched first. <code>in_key</code>
704 is considered more specific than <code>local_ip</code> if a port
705 defines one and another port defines the other. The following
706 options may be specified in the <ref column="options"/> column:
708 <dt><code>remote_ip</code></dt>
709 <dd>Required. The tunnel endpoint.</dd>
712 <dt><code>local_ip</code></dt>
713 <dd>Optional. The destination IP that received packets must
714 match. Default is to match all addresses.</dd>
717 <dt><code>in_key</code></dt>
718 <dd>Optional. The GRE key that received packets must contain.
719 It may either be a 32-bit number (no key and a key of 0 are
720 treated as equivalent) or the word <code>flow</code>. If
721 <code>flow</code> is specified then any key will be accepted
722 and the key will be placed in the <code>tun_id</code> field
723 for matching in the flow table. The ovs-ofctl manual page
724 contains additional information about matching fields in
725 OpenFlow flows. Default is no key.</dd>
728 <dt><code>out_key</code></dt>
729 <dd>Optional. The GRE key to be set on outgoing packets. It may
730 either be a 32-bit number or the word <code>flow</code>. If
731 <code>flow</code> is specified then the key may be set using
732 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
733 is used in the absence of an action). The ovs-ofctl manual
734 page contains additional information about the Nicira OpenFlow
735 vendor extensions. Default is no key.</dd>
738 <dt><code>key</code></dt>
739 <dd>Optional. Shorthand to set <code>in_key</code> and
740 <code>out_key</code> at the same time.</dd>
743 <dt><code>tos</code></dt>
744 <dd>Optional. The value of the ToS bits to be set on the
745 encapsulating packet. It may also be the word
746 <code>inherit</code>, in which case the ToS will be copied from
747 the inner packet if it is IPv4 or IPv6 (otherwise it will be
748 0). Note that the ECN fields are always inherited. Default is
752 <dt><code>ttl</code></dt>
753 <dd>Optional. The TTL to be set on the encapsulating packet.
754 It may also be the word <code>inherit</code>, in which case the
755 TTL will be copied from the inner packet if it is IPv4 or IPv6
756 (otherwise it will be the system default, typically 64).
757 Default is the system default TTL.</dd>
760 <dt><code>csum</code></dt>
761 <dd>Optional. Compute GRE checksums on outgoing packets.
762 Checksums present on incoming packets will be validated
763 regardless of this setting. Note that GRE checksums
764 impose a significant performance penalty as they cover the
765 entire packet. As the contents of the packet is typically
766 covered by L3 and L4 checksums, this additional checksum only
767 adds value for the GRE and encapsulated Ethernet headers.
768 Default is disabled, set to <code>true</code> to enable.</dd>
771 <dt><code>pmtud</code></dt>
772 <dd>Optional. Enable tunnel path MTU discovery. If enabled
773 ``ICMP destination unreachable - fragmentation'' needed
774 messages will be generated for IPv4 packets with the DF bit set
775 and IPv6 packets above the minimum MTU if the packet size
776 exceeds the path MTU minus the size of the tunnel headers. It
777 also forces the encapsulating packet DF bit to be set (it is
778 always set if the inner packet implies path MTU discovery).
779 Note that this option causes behavior that is typically
780 reserved for routers and therefore is not entirely in
781 compliance with the IEEE 802.1D specification for bridges.
782 Default is enabled, set to <code>false</code> to disable.</dd>
785 <dt><code>header_cache</code></dt>
786 <dd>Optional. Enable caching of tunnel headers and the output
787 path. This can lead to a significant performance increase
788 without changing behavior. In general it should not be
789 necessary to adjust this setting. However, the caching can
790 bypass certain components of the IP stack (such as IP tables)
791 and it may be useful to disable it if these features are
792 required or as a debugging measure. Default is enabled, set to
793 <code>false</code> to disable.</dd>
796 <dt><code>ipsec_gre</code></dt>
797 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
798 over IPv4 IPsec tunnel. Each tunnel (including those of type
799 <code>gre</code>) must be uniquely identified by the
800 combination of <code>remote_ip</code> and
801 <code>local_ip</code>. Note that if two ports are defined
802 that are the same except one has an optional identifier and
803 the other does not, the more specific one is matched first.
804 An authentication method of <code>peer_cert</code> or
805 <code>psk</code> must be defined. The following options may
806 be specified in the <ref column="options"/> column:
808 <dt><code>remote_ip</code></dt>
809 <dd>Required. The tunnel endpoint.</dd>
812 <dt><code>local_ip</code></dt>
813 <dd>Optional. The destination IP that received packets must
814 match. Default is to match all addresses.</dd>
817 <dt><code>peer_cert</code></dt>
818 <dd>Required for certificate authentication. A string
819 containing the peer's certificate in PEM format.
820 Additionally the host's certificate must be specified
821 with the <code>certificate</code> option.</dd>
824 <dt><code>certificate</code></dt>
825 <dd>Required for certificate authentication. The name of a
826 PEM file containing a certificate that will be presented
827 to the peer during authentication.</dd>
830 <dt><code>private_key</code></dt>
831 <dd>Optional for certificate authentication. The name of
832 a PEM file containing the private key associated with
833 <code>certificate</code>. If <code>certificate</code>
834 contains the private key, this option may be omitted.</dd>
837 <dt><code>psk</code></dt>
838 <dd>Required for pre-shared key authentication. Specifies a
839 pre-shared key for authentication that must be identical on
840 both sides of the tunnel.</dd>
843 <dt><code>in_key</code></dt>
844 <dd>Optional. The GRE key that received packets must contain.
845 It may either be a 32-bit number (no key and a key of 0 are
846 treated as equivalent) or the word <code>flow</code>. If
847 <code>flow</code> is specified then any key will be accepted
848 and the key will be placed in the <code>tun_id</code> field
849 for matching in the flow table. The ovs-ofctl manual page
850 contains additional information about matching fields in
851 OpenFlow flows. Default is no key.</dd>
854 <dt><code>out_key</code></dt>
855 <dd>Optional. The GRE key to be set on outgoing packets. It may
856 either be a 32-bit number or the word <code>flow</code>. If
857 <code>flow</code> is specified then the key may be set using
858 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
859 is used in the absence of an action). The ovs-ofctl manual
860 page contains additional information about the Nicira OpenFlow
861 vendor extensions. Default is no key.</dd>
864 <dt><code>key</code></dt>
865 <dd>Optional. Shorthand to set <code>in_key</code> and
866 <code>out_key</code> at the same time.</dd>
869 <dt><code>tos</code></dt>
870 <dd>Optional. The value of the ToS bits to be set on the
871 encapsulating packet. It may also be the word
872 <code>inherit</code>, in which case the ToS will be copied from
873 the inner packet if it is IPv4 or IPv6 (otherwise it will be
874 0). Note that the ECN fields are always inherited. Default is
878 <dt><code>ttl</code></dt>
879 <dd>Optional. The TTL to be set on the encapsulating packet.
880 It may also be the word <code>inherit</code>, in which case the
881 TTL will be copied from the inner packet if it is IPv4 or IPv6
882 (otherwise it will be the system default, typically 64).
883 Default is the system default TTL.</dd>
886 <dt><code>csum</code></dt>
887 <dd>Optional. Compute GRE checksums on outgoing packets.
888 Checksums present on incoming packets will be validated
889 regardless of this setting. Note that GRE checksums
890 impose a significant performance penalty as they cover the
891 entire packet. As the contents of the packet is typically
892 covered by L3 and L4 checksums, this additional checksum only
893 adds value for the GRE and encapsulated Ethernet headers.
894 Default is disabled, set to <code>true</code> to enable.</dd>
897 <dt><code>pmtud</code></dt>
898 <dd>Optional. Enable tunnel path MTU discovery. If enabled
899 ``ICMP destination unreachable - fragmentation'' needed
900 messages will be generated for IPv4 packets with the DF bit set
901 and IPv6 packets above the minimum MTU if the packet size
902 exceeds the path MTU minus the size of the tunnel headers. It
903 also forces the encapsulating packet DF bit to be set (it is
904 always set if the inner packet implies path MTU discovery).
905 Note that this option causes behavior that is typically
906 reserved for routers and therefore is not entirely in
907 compliance with the IEEE 802.1D specification for bridges.
908 Default is enabled, set to <code>false</code> to disable.</dd>
911 <dt><code>capwap</code></dt>
912 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
913 (RFC 5415). This allows interoperability with certain switches
914 where GRE is not available. Note that only the tunneling component
915 of the protocol is implemented. Due to the non-standard use of
916 CAPWAP, UDP ports 58881 and 58882 are used as the source and
917 destinations ports respectivedly. Each tunnel must be uniquely
918 identified by the combination of <code>remote_ip</code> and
919 <code>local_ip</code>. If two ports are defined that are the same
920 except one includes <code>local_ip</code> and the other does not,
921 the more specific one is matched first. CAPWAP support is not
922 available on all platforms. Currently it is only supported in the
923 Linux kernel module with kernel versions >= 2.6.25. The following
924 options may be specified in the <ref column="options"/> column:
926 <dt><code>remote_ip</code></dt>
927 <dd>Required. The tunnel endpoint.</dd>
930 <dt><code>local_ip</code></dt>
931 <dd>Optional. The destination IP that received packets must
932 match. Default is to match all addresses.</dd>
935 <dt><code>tos</code></dt>
936 <dd>Optional. The value of the ToS bits to be set on the
937 encapsulating packet. It may also be the word
938 <code>inherit</code>, in which case the ToS will be copied from
939 the inner packet if it is IPv4 or IPv6 (otherwise it will be
940 0). Note that the ECN fields are always inherited. Default is
944 <dt><code>ttl</code></dt>
945 <dd>Optional. The TTL to be set on the encapsulating packet.
946 It may also be the word <code>inherit</code>, in which case the
947 TTL will be copied from the inner packet if it is IPv4 or IPv6
948 (otherwise it will be the system default, typically 64).
949 Default is the system default TTL.</dd>
952 <dt><code>pmtud</code></dt>
953 <dd>Optional. Enable tunnel path MTU discovery. If enabled
954 ``ICMP destination unreachable - fragmentation'' needed
955 messages will be generated for IPv4 packets with the DF bit set
956 and IPv6 packets above the minimum MTU if the packet size
957 exceeds the path MTU minus the size of the tunnel headers. It
958 also forces the encapsulating packet DF bit to be set (it is
959 always set if the inner packet implies path MTU discovery).
960 Note that this option causes behavior that is typically
961 reserved for routers and therefore is not entirely in
962 compliance with the IEEE 802.1D specification for bridges.
963 Default is enabled, set to <code>false</code> to disable.</dd>
966 <dt><code>header_cache</code></dt>
967 <dd>Optional. Enable caching of tunnel headers and the output
968 path. This can lead to a significant performance increase
969 without changing behavior. In general it should not be
970 necessary to adjust this setting. However, the caching can
971 bypass certain components of the IP stack (such as IP tables)
972 and it may be useful to disable it if these features are
973 required or as a debugging measure. Default is enabled, set to
974 <code>false</code> to disable.</dd>
977 <dt><code>patch</code></dt>
980 A pair of virtual devices that act as a patch cable. The <ref
981 column="options"/> column must have the following key-value pair:
984 <dt><code>peer</code></dt>
986 The <ref column="name"/> of the <ref table="Interface"/> for
987 the other side of the patch. The named <ref
988 table="Interface"/>'s own <code>peer</code> option must specify
989 this <ref table="Interface"/>'s name. That is, the two patch
990 interfaces must have reversed <ref column="name"/> and
991 <code>peer</code> values.
998 <column name="options">
999 Configuration options whose interpretation varies based on
1000 <ref column="type"/>.
1004 <group title="Interface Status">
1006 Status information about interfaces attached to bridges, updated every
1007 5 seconds. Not all interfaces have all of these properties; virtual
1008 interfaces don't have a link speed, for example. Non-applicable
1009 columns will have empty values.
1011 <column name="admin_state">
1013 The administrative state of the physical network link.
1017 <column name="link_state">
1019 The observed state of the physical network link;
1020 i.e. whether a carrier is detected by the interface.
1024 <column name="link_speed">
1026 The negotiated speed of the physical network link.
1027 Valid values are positive integers greater than 0.
1031 <column name="duplex">
1033 The duplex mode of the physical network link.
1039 The MTU (maximum transmission unit); i.e. the largest
1040 amount of data that can fit into a single Ethernet frame.
1041 The standard Ethernet MTU is 1500 bytes. Some physical media
1042 and many kinds of virtual interfaces can be configured with
1047 <column name="status">
1049 Key-value pairs that report port status. Supported status
1050 values are <code>type</code>-dependent; some interfaces may not have
1051 a valid <code>driver_name</code>, for example.
1053 <p>The currently defined key-value pairs are:</p>
1055 <dt><code>driver_name</code></dt>
1056 <dd>The name of the device driver controlling the network
1060 <dt><code>driver_version</code></dt>
1061 <dd>The version string of the device driver controlling the
1062 network adapter.</dd>
1065 <dt><code>firmware_version</code></dt>
1066 <dd>The version string of the network adapter's firmware, if
1070 <dt><code>source_ip</code></dt>
1071 <dd>The source IP address used for an IPv4 tunnel end-point,
1072 such as <code>gre</code> or <code>capwap</code>.</dd>
1075 <dt><code>tunnel_egress_iface</code></dt>
1076 <dd>Egress interface for tunnels. Currently only relevant for GRE
1077 and CAPWAP tunnels. On Linux systems, this column will show
1078 the name of the interface which is responsible for routing
1079 traffic destined for the configured <code>remote_ip</code>.
1080 This could be an internal interface such as a bridge port.</dd>
1083 <dt><code>tunnel_egress_iface_carrier</code></dt>
1084 <dd>Whether a carrier is detected on <ref
1085 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1086 and <code>up</code>.</dd>
1091 <group title="Ingress Policing">
1093 These settings control ingress policing for packets received on this
1094 interface. On a physical interface, this limits the rate at which
1095 traffic is allowed into the system from the outside; on a virtual
1096 interface (one connected to a virtual machine), this limits the rate at
1097 which the VM is able to transmit.
1100 Policing is a simple form of quality-of-service that simply drops
1101 packets received in excess of the configured rate. Due to its
1102 simplicity, policing is usually less accurate and less effective than
1103 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1104 table="Queue"/> tables).
1107 Policing is currently implemented only on Linux. The Linux
1108 implementation uses a simple ``token bucket'' approach:
1112 The size of the bucket corresponds to <ref
1113 column="ingress_policing_burst"/>. Initially the bucket is full.
1116 Whenever a packet is received, its size (converted to tokens) is
1117 compared to the number of tokens currently in the bucket. If the
1118 required number of tokens are available, they are removed and the
1119 packet is forwarded. Otherwise, the packet is dropped.
1122 Whenever it is not full, the bucket is refilled with tokens at the
1123 rate specified by <ref column="ingress_policing_rate"/>.
1127 Policing interacts badly with some network protocols, and especially
1128 with fragmented IP packets. Suppose that there is enough network
1129 activity to keep the bucket nearly empty all the time. Then this token
1130 bucket algorithm will forward a single packet every so often, with the
1131 period depending on packet size and on the configured rate. All of the
1132 fragments of an IP packets are normally transmitted back-to-back, as a
1133 group. In such a situation, therefore, only one of these fragments
1134 will be forwarded and the rest will be dropped. IP does not provide
1135 any way for the intended recipient to ask for only the remaining
1136 fragments. In such a case there are two likely possibilities for what
1137 will happen next: either all of the fragments will eventually be
1138 retransmitted (as TCP will do), in which case the same problem will
1139 recur, or the sender will not realize that its packet has been dropped
1140 and data will simply be lost (as some UDP-based protocols will do).
1141 Either way, it is possible that no forward progress will ever occur.
1143 <column name="ingress_policing_rate">
1145 Maximum rate for data received on this interface, in kbps. Data
1146 received faster than this rate is dropped. Set to <code>0</code>
1147 (the default) to disable policing.
1151 <column name="ingress_policing_burst">
1152 <p>Maximum burst size for data received on this interface, in kb. The
1153 default burst size if set to <code>0</code> is 1000 kb. This value
1154 has no effect if <ref column="ingress_policing_rate"/>
1155 is <code>0</code>.</p>
1157 Specifying a larger burst size lets the algorithm be more forgiving,
1158 which is important for protocols like TCP that react severely to
1159 dropped packets. The burst size should be at least the size of the
1160 interface's MTU. Specifying a value that is numerically at least as
1161 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1162 closer to achieving the full rate.
1167 <group title="Other Features">
1169 <column name="monitor">
1170 Connectivity monitor configuration for this interface.
1173 <column name="external_ids">
1174 Key-value pairs for use by external frameworks that integrate
1175 with Open vSwitch, rather than by Open vSwitch itself. System
1176 integrators should either use the Open vSwitch development
1177 mailing list to coordinate on common key-value definitions, or
1178 choose key names that are likely to be unique. The currently
1179 defined common key-value pairs are:
1181 <dt><code>attached-mac</code></dt>
1183 The MAC address programmed into the ``virtual hardware'' for this
1184 interface, in the form
1185 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1186 For Citrix XenServer, this is the value of the <code>MAC</code>
1187 field in the VIF record for this interface.</dd>
1188 <dt><code>iface-id</code></dt>
1189 <dd>A system-unique identifier for the interface. On XenServer,
1190 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1193 Additionally the following key-value pairs specifically
1194 apply to an interface that represents a virtual Ethernet interface
1195 connected to a virtual machine. These key-value pairs should not be
1196 present for other types of interfaces. Keys whose names end
1197 in <code>-uuid</code> have values that uniquely identify the entity
1198 in question. For a Citrix XenServer hypervisor, these values are
1199 UUIDs in RFC 4122 format. Other hypervisors may use other
1202 <p>The currently defined key-value pairs for XenServer are:</p>
1204 <dt><code>xs-vif-uuid</code></dt>
1205 <dd>The virtual interface associated with this interface.</dd>
1206 <dt><code>xs-network-uuid</code></dt>
1207 <dd>The virtual network to which this interface is attached.</dd>
1208 <dt><code>xs-vm-uuid</code></dt>
1209 <dd>The VM to which this interface belongs.</dd>
1213 <column name="other_config">
1214 Key-value pairs for rarely used interface features.
1216 <dt><code>lacp-port-priority</code></dt>
1217 <dd> The LACP port priority of this <ref table="Interface"/>. In
1218 LACP negotiations <ref table="Interface"/>s with numerically lower
1219 priorities are preferred for aggregation. Must be a number between
1224 <column name="statistics">
1226 Key-value pairs that report interface statistics. The current
1227 implementation updates these counters periodically. In the future,
1228 we plan to, instead, update them when an interface is created, when
1229 they are queried (e.g. using an OVSDB <code>select</code> operation),
1230 and just before an interface is deleted due to virtual interface
1231 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1232 regular periodic basis.</p>
1234 The currently defined key-value pairs are listed below. These are
1235 the same statistics reported by OpenFlow in its <code>struct
1236 ofp_port_stats</code> structure. If an interface does not support a
1237 given statistic, then that pair is omitted.</p>
1240 Successful transmit and receive counters:
1242 <dt><code>rx_packets</code></dt>
1243 <dd>Number of received packets.</dd>
1244 <dt><code>rx_bytes</code></dt>
1245 <dd>Number of received bytes.</dd>
1246 <dt><code>tx_packets</code></dt>
1247 <dd>Number of transmitted packets.</dd>
1248 <dt><code>tx_bytes</code></dt>
1249 <dd>Number of transmitted bytes.</dd>
1255 <dt><code>rx_dropped</code></dt>
1256 <dd>Number of packets dropped by RX.</dd>
1257 <dt><code>rx_frame_err</code></dt>
1258 <dd>Number of frame alignment errors.</dd>
1259 <dt><code>rx_over_err</code></dt>
1260 <dd>Number of packets with RX overrun.</dd>
1261 <dt><code>rx_crc_err</code></dt>
1262 <dd>Number of CRC errors.</dd>
1263 <dt><code>rx_errors</code></dt>
1265 Total number of receive errors, greater than or equal
1266 to the sum of the above.
1273 <dt><code>tx_dropped</code></dt>
1274 <dd>Number of packets dropped by TX.</dd>
1275 <dt><code>collisions</code></dt>
1276 <dd>Number of collisions.</dd>
1277 <dt><code>tx_errors</code></dt>
1279 Total number of transmit errors, greater
1280 than or equal to the sum of the above.
1289 <table name="QoS" title="Quality of Service configuration">
1290 <p>Quality of Service (QoS) configuration for each Port that
1293 <column name="type">
1294 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1295 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1296 identifies the types that a switch actually supports. The currently
1297 defined types are listed below:</p>
1299 <dt><code>linux-htb</code></dt>
1301 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1302 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1303 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1304 for information on how this classifier works and how to configure it.
1308 <dt><code>linux-hfsc</code></dt>
1310 Linux "Hierarchical Fair Service Curve" classifier.
1311 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1312 information on how this classifier works.
1317 <column name="queues">
1318 <p>A map from queue numbers to <ref table="Queue"/> records. The
1319 supported range of queue numbers depend on <ref column="type"/>. The
1320 queue numbers are the same as the <code>queue_id</code> used in
1321 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1322 structures. Queue 0 is used by OpenFlow output actions that do not
1323 specify a specific queue.</p>
1326 <column name="other_config">
1327 <p>Key-value pairs for configuring QoS features that depend on
1328 <ref column="type"/>.</p>
1329 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1330 the following key-value pairs:</p>
1332 <dt><code>max-rate</code></dt>
1333 <dd>Maximum rate shared by all queued traffic, in bit/s.
1334 Optional. If not specified, for physical interfaces, the
1335 default is the link rate. For other interfaces or if the
1336 link rate cannot be determined, the default is currently 100
1341 <column name="external_ids">
1342 Key-value pairs for use by external frameworks that integrate with Open
1343 vSwitch, rather than by Open vSwitch itself. System integrators should
1344 either use the Open vSwitch development mailing list to coordinate on
1345 common key-value definitions, or choose key names that are likely to be
1346 unique. No common key-value pairs are currently defined.
1350 <table name="Queue" title="QoS output queue.">
1351 <p>A configuration for a port output queue, used in configuring Quality of
1352 Service (QoS) features. May be referenced by <ref column="queues"
1353 table="QoS"/> column in <ref table="QoS"/> table.</p>
1355 <column name="other_config">
1356 <p>Key-value pairs for configuring the output queue. The supported
1357 key-value pairs and their meanings depend on the <ref column="type"/>
1358 of the <ref column="QoS"/> records that reference this row.</p>
1359 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1360 column="type"/> of <code>min-rate</code> are:</p>
1362 <dt><code>min-rate</code></dt>
1363 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1364 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1366 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1367 column="type"/> of <code>linux-htb</code> are:</p>
1369 <dt><code>min-rate</code></dt>
1370 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1371 <dt><code>max-rate</code></dt>
1372 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1373 queue's rate will not be allowed to exceed the specified value, even
1374 if excess bandwidth is available. If unspecified, defaults to no
1376 <dt><code>burst</code></dt>
1377 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1378 that a queue can accumulate while it is idle. Optional. Details of
1379 the <code>linux-htb</code> implementation require a minimum burst
1380 size, so a too-small <code>burst</code> will be silently
1382 <dt><code>priority</code></dt>
1383 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1384 unspecified. A queue with a smaller <code>priority</code>
1385 will receive all the excess bandwidth that it can use before
1386 a queue with a larger value receives any. Specific priority
1387 values are unimportant; only relative ordering matters.</dd>
1389 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1390 column="type"/> of <code>linux-hfsc</code> are:</p>
1392 <dt><code>min-rate</code></dt>
1393 <dd>Minimum guaranteed bandwidth, in bit/s. Required.</dd>
1394 <dt><code>max-rate</code></dt>
1395 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1396 queue's rate will not be allowed to exceed the specified value, even
1397 if excess bandwidth is available. If unspecified, defaults to no
1402 <column name="external_ids">
1403 Key-value pairs for use by external frameworks that integrate with Open
1404 vSwitch, rather than by Open vSwitch itself. System integrators should
1405 either use the Open vSwitch development mailing list to coordinate on
1406 common key-value definitions, or choose key names that are likely to be
1407 unique. No common key-value pairs are currently defined.
1411 <table name="Monitor" title="Connectivity Monitor configuration">
1413 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1414 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1415 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1416 to detect connectivity problems with each other. MPs within a MA should
1417 have complete and exclusive interconnectivity. This is verified by
1418 occasionally broadcasting Continuity Check Messages (CCMs) at a
1419 configurable transmission interval. A <ref table="Monitor"/> is
1420 responsible for collecting data about other MPs in its MA and
1424 <group title="Monitor Configuration">
1425 <column name="mpid">
1426 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1427 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1428 used to identify this <ref table="Monitor"/> to other endpoints in the
1432 <column name="remote_mps">
1433 A set of <ref table="Maintenance_Points"/> which this
1434 <ref table="Monitor"/> should have connectivity to. If this
1435 <ref table="Monitor"/> does not have connectivity to any MPs in this
1436 set, or has connectivity to any MPs not in this set, a fault is
1440 <column name="ma_name">
1441 A Maintenance Association (MA) name pairs with a Maintenance Domain
1442 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1443 have complete and exclusive interconnectivity. Defaults to
1444 <code>ovs</code> if unset.
1447 <column name="md_name">
1448 A Maintenance Domain name pairs with a Maintenance Association name to
1449 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1452 <column name="interval">
1453 The transmission interval of CCMs in milliseconds. Three missed CCMs
1454 indicate a connectivity fault. Defaults to 1000ms.
1458 <group title="Monitor Status">
1459 <column name="unexpected_remote_mpids">
1460 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1461 has detected connectivity that are not in the
1462 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1463 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1464 Thus, if this set is non-empty a fault is indicated.
1467 <column name="unexpected_remote_maids">
1468 A set of MAIDs representing foreign Maintenance Associations (MAs)
1469 which this <ref table="Monitor"/> has detected connectivity to. A
1470 <ref table="Monitor"/> should not have connectivity to a Maintenance
1471 Association other than its own. Thus, if this set is non-empty a fault
1475 <column name="fault">
1476 Indicates a Connectivity Fault caused by a configuration error, a down
1477 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1482 <table name="Maintenance_Point" title="Maintenance Point configuration">
1484 A <ref table="Maintenance_Point"/> represents a MP which a
1485 <ref table="Monitor"/> has or should have connectivity to.
1488 <group title="Maintenance_Point Configuration">
1489 <column name="mpid">
1490 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1491 a Maintenance Association. All MPs within a MA should have a unique
1496 <group title="Maintenance_Point Status">
1497 <column name="fault">
1498 Indicates a connectivity fault.
1503 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1504 <p>A port mirror within a <ref table="Bridge"/>.</p>
1505 <p>A port mirror configures a bridge to send selected frames to special
1506 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1507 traffic may also be referred to as SPAN or RSPAN, depending on the
1508 mechanism used for delivery.</p>
1510 <column name="name">
1511 Arbitrary identifier for the <ref table="Mirror"/>.
1514 <group title="Selecting Packets for Mirroring">
1515 <column name="select_all">
1516 If true, every packet arriving or departing on any port is
1517 selected for mirroring.
1520 <column name="select_dst_port">
1521 Ports on which departing packets are selected for mirroring.
1524 <column name="select_src_port">
1525 Ports on which arriving packets are selected for mirroring.
1528 <column name="select_vlan">
1529 VLANs on which packets are selected for mirroring. An empty set
1530 selects packets on all VLANs.
1534 <group title="Mirroring Destination Configuration">
1535 <column name="output_port">
1536 <p>Output port for selected packets, if nonempty. Mutually exclusive
1537 with <ref column="output_vlan"/>.</p>
1538 <p>Specifying a port for mirror output reserves that port exclusively
1539 for mirroring. No frames other than those selected for mirroring
1540 will be forwarded to the port, and any frames received on the port
1541 will be discarded.</p>
1542 <p>This type of mirroring is sometimes called SPAN.</p>
1545 <column name="output_vlan">
1546 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1547 with <ref column="output_port"/>.</p>
1548 <p>The frames will be sent out all ports that trunk
1549 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1550 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1551 trunk port, the frame's VLAN tag will be set to
1552 <ref column="output_vlan"/>, replacing any existing tag; when it is
1553 sent out an implicit VLAN port, the frame will not be tagged. This
1554 type of mirroring is sometimes called RSPAN.</p>
1555 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1556 contains unmanaged switches. Consider an unmanaged physical switch
1557 with two ports: port 1, connected to an end host, and port 2,
1558 connected to an Open vSwitch configured to mirror received packets
1559 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1560 port 1 that the physical switch forwards to port 2. The Open vSwitch
1561 forwards this packet to its destination and then reflects it back on
1562 port 2 in VLAN 123. This reflected packet causes the unmanaged
1563 physical switch to replace the MAC learning table entry, which
1564 correctly pointed to port 1, with one that incorrectly points to port
1565 2. Afterward, the physical switch will direct packets destined for
1566 the end host to the Open vSwitch on port 2, instead of to the end
1567 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1568 desired in this scenario, then the physical switch must be replaced
1569 by one that learns Ethernet addresses on a per-VLAN basis. In
1570 addition, learning should be disabled on the VLAN containing mirrored
1571 traffic. If this is not done then intermediate switches will learn
1572 the MAC address of each end host from the mirrored traffic. If
1573 packets being sent to that end host are also mirrored, then they will
1574 be dropped since the switch will attempt to send them out the input
1575 port. Disabling learning for the VLAN will cause the switch to
1576 correctly send the packet out all ports configured for that VLAN. If
1577 Open vSwitch is being used as an intermediate switch, learning can be
1578 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1579 in the appropriate <ref table="Bridge"/> table or tables.</p>
1583 <group title="Other Features">
1584 <column name="external_ids">
1585 Key-value pairs for use by external frameworks that integrate with Open
1586 vSwitch, rather than by Open vSwitch itself. System integrators should
1587 either use the Open vSwitch development mailing list to coordinate on
1588 common key-value definitions, or choose key names that are likely to be
1589 unique. No common key-value pairs are currently defined.
1594 <table name="Controller" title="OpenFlow controller configuration.">
1595 <p>An OpenFlow controller.</p>
1598 Open vSwitch supports two kinds of OpenFlow controllers:
1602 <dt>Primary controllers</dt>
1605 This is the kind of controller envisioned by the OpenFlow 1.0
1606 specification. Usually, a primary controller implements a network
1607 policy by taking charge of the switch's flow table.
1611 Open vSwitch initiates and maintains persistent connections to
1612 primary controllers, retrying the connection each time it fails or
1613 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1614 <ref table="Bridge"/> table applies to primary controllers.
1618 Open vSwitch permits a bridge to have any number of primary
1619 controllers. When multiple controllers are configured, Open
1620 vSwitch connects to all of them simultaneously. Because
1621 OpenFlow 1.0 does not specify how multiple controllers
1622 coordinate in interacting with a single switch, more than
1623 one primary controller should be specified only if the
1624 controllers are themselves designed to coordinate with each
1625 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1626 vendor extension may be useful for this.)
1629 <dt>Service controllers</dt>
1632 These kinds of OpenFlow controller connections are intended for
1633 occasional support and maintenance use, e.g. with
1634 <code>ovs-ofctl</code>. Usually a service controller connects only
1635 briefly to inspect or modify some of a switch's state.
1639 Open vSwitch listens for incoming connections from service
1640 controllers. The service controllers initiate and, if necessary,
1641 maintain the connections from their end. The <ref table="Bridge"
1642 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1643 not apply to service controllers.
1647 Open vSwitch supports configuring any number of service controllers.
1653 The <ref column="target"/> determines the type of controller.
1656 <group title="Core Features">
1657 <column name="target">
1658 <p>Connection method for controller.</p>
1660 The following connection methods are currently supported for primary
1664 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1666 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1667 the given <var>ip</var>, which must be expressed as an IP address
1668 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1669 column in the <ref table="Open_vSwitch"/> table must point to a
1670 valid SSL configuration when this form is used.</p>
1671 <p>SSL support is an optional feature that is not always built as
1672 part of Open vSwitch.</p>
1674 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1675 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1676 the given <var>ip</var>, which must be expressed as an IP address
1677 (not a DNS name).</dd>
1678 <dt><code>discover</code></dt>
1680 <p>Enables controller discovery.</p>
1681 <p>In controller discovery mode, Open vSwitch broadcasts a DHCP
1682 request with vendor class identifier <code>OpenFlow</code> across
1683 all of the bridge's network devices. It will accept any valid
1684 DHCP reply that has the same vendor class identifier and includes
1685 a vendor-specific option with code 1 whose contents are a string
1686 specifying the location of the controller in the same format as
1687 <ref column="target"/>.</p>
1688 <p>The DHCP reply may also, optionally, include a vendor-specific
1689 option with code 2 whose contents are a string specifying the URI
1690 to the base of the OpenFlow PKI
1691 (e.g. <code>http://192.168.0.1/openflow/pki</code>). This URI is
1692 used only for bootstrapping the OpenFlow PKI at initial switch
1693 setup; <code>ovs-vswitchd</code> does not use it at all.</p>
1697 The following connection methods are currently supported for service
1701 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1704 Listens for SSL connections on the specified TCP <var>port</var>
1705 (default: 6633). If <var>ip</var>, which must be expressed as an
1706 IP address (not a DNS name), is specified, then connections are
1707 restricted to the specified local IP address.
1710 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1711 table="Open_vSwitch"/> table must point to a valid SSL
1712 configuration when this form is used.
1714 <p>SSL support is an optional feature that is not always built as
1715 part of Open vSwitch.</p>
1717 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1719 Listens for connections on the specified TCP <var>port</var>
1720 (default: 6633). If <var>ip</var>, which must be expressed as an
1721 IP address (not a DNS name), is specified, then connections are
1722 restricted to the specified local IP address.
1725 <p>When multiple controllers are configured for a single bridge, the
1726 <ref column="target"/> values must be unique. Duplicate
1727 <ref column="target"/> values yield unspecified results.</p>
1730 <column name="connection_mode">
1731 <p>If it is specified, this setting must be one of the following
1732 strings that describes how Open vSwitch contacts this OpenFlow
1733 controller over the network:</p>
1736 <dt><code>in-band</code></dt>
1737 <dd>In this mode, this controller's OpenFlow traffic travels over the
1738 bridge associated with the controller. With this setting, Open
1739 vSwitch allows traffic to and from the controller regardless of the
1740 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1741 would never be able to connect to the controller, because it did
1742 not have a flow to enable it.) This is the most common connection
1743 mode because it is not necessary to maintain two independent
1745 <dt><code>out-of-band</code></dt>
1746 <dd>In this mode, OpenFlow traffic uses a control network separate
1747 from the bridge associated with this controller, that is, the
1748 bridge does not use any of its own network devices to communicate
1749 with the controller. The control network must be configured
1750 separately, before or after <code>ovs-vswitchd</code> is started.
1754 <p>If not specified, the default is implementation-specific. If
1755 <ref column="target"/> is <code>discover</code>, the connection mode
1756 is always treated as <code>in-band</code> regardless of the actual
1761 <group title="Controller Failure Detection and Handling">
1762 <column name="max_backoff">
1763 Maximum number of milliseconds to wait between connection attempts.
1764 Default is implementation-specific.
1767 <column name="inactivity_probe">
1768 Maximum number of milliseconds of idle time on connection to
1769 controller before sending an inactivity probe message. If Open
1770 vSwitch does not communicate with the controller for the specified
1771 number of seconds, it will send a probe. If a response is not
1772 received for the same additional amount of time, Open vSwitch
1773 assumes the connection has been broken and attempts to reconnect.
1774 Default is implementation-specific.
1778 <group title="OpenFlow Rate Limiting">
1779 <column name="controller_rate_limit">
1780 <p>The maximum rate at which packets in unknown flows will be
1781 forwarded to the OpenFlow controller, in packets per second. This
1782 feature prevents a single bridge from overwhelming the controller.
1783 If not specified, the default is implementation-specific.</p>
1784 <p>In addition, when a high rate triggers rate-limiting, Open
1785 vSwitch queues controller packets for each port and transmits
1786 them to the controller at the configured rate. The number of
1787 queued packets is limited by
1788 the <ref column="controller_burst_limit"/> value. The packet
1789 queue is shared fairly among the ports on a bridge.</p><p>Open
1790 vSwitch maintains two such packet rate-limiters per bridge.
1791 One of these applies to packets sent up to the controller
1792 because they do not correspond to any flow. The other applies
1793 to packets sent up to the controller by request through flow
1794 actions. When both rate-limiters are filled with packets, the
1795 actual rate that packets are sent to the controller is up to
1796 twice the specified rate.</p>
1799 <column name="controller_burst_limit">
1800 In conjunction with <ref column="controller_rate_limit"/>,
1801 the maximum number of unused packet credits that the bridge will
1802 allow to accumulate, in packets. If not specified, the default
1803 is implementation-specific.
1807 <group title="Additional Discovery Configuration">
1808 <p>These values are considered only when <ref column="target"/>
1809 is <code>discover</code>.</p>
1811 <column name="discover_accept_regex">
1813 extended regular expression against which the discovered controller
1814 location is validated. The regular expression is implicitly
1815 anchored at the beginning of the controller location string, as
1816 if it begins with <code>^</code>. If not specified, the default
1817 is implementation-specific.
1820 <column name="discover_update_resolv_conf">
1821 Whether to update <code>/etc/resolv.conf</code> when the
1822 controller is discovered. If not specified, the default
1823 is implementation-specific. Open vSwitch will only modify
1824 <code>/etc/resolv.conf</code> if the DHCP response that it receives
1825 specifies one or more DNS servers.
1829 <group title="Additional In-Band Configuration">
1830 <p>These values are considered only in in-band control mode (see
1831 <ref column="connection_mode"/>) and only when <ref column="target"/>
1832 is not <code>discover</code>. (For controller discovery, the network
1833 configuration obtained via DHCP is used instead.)</p>
1835 <p>When multiple controllers are configured on a single bridge, there
1836 should be only one set of unique values in these columns. If different
1837 values are set for these columns in different controllers, the effect
1840 <column name="local_ip">
1841 The IP address to configure on the local port,
1842 e.g. <code>192.168.0.123</code>. If this value is unset, then
1843 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1847 <column name="local_netmask">
1848 The IP netmask to configure on the local port,
1849 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1850 but this value is unset, then the default is chosen based on whether
1851 the IP address is class A, B, or C.
1854 <column name="local_gateway">
1855 The IP address of the gateway to configure on the local port, as a
1856 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1857 this network has no gateway.
1861 <group title="Other Features">
1862 <column name="external_ids">
1863 Key-value pairs for use by external frameworks that integrate with Open
1864 vSwitch, rather than by Open vSwitch itself. System integrators should
1865 either use the Open vSwitch development mailing list to coordinate on
1866 common key-value definitions, or choose key names that are likely to be
1867 unique. No common key-value pairs are currently defined.
1871 <group title="Controller Status">
1872 <column name="is_connected">
1873 <code>true</code> if currently connected to this controller,
1874 <code>false</code> otherwise.
1877 <column name="role">
1878 <p>The level of authority this controller has on the associated
1879 bridge. Possible values are:</p>
1881 <dt><code>other</code></dt>
1882 <dd>Allows the controller access to all OpenFlow features.</dd>
1885 <dt><code>master</code></dt>
1886 <dd>Equivalent to <code>other</code>, except that there may be at
1887 most one master controller at a time. When a controller configures
1888 itself as <code>master</code>, any existing master is demoted to
1889 the <code>slave</code>role.</dd>
1892 <dt><code>slave</code></dt>
1893 <dd>Allows the controller read-only access to OpenFlow features.
1894 Attempts to modify the flow table will be rejected with an
1895 error. Slave controllers do not receive OFPT_PACKET_IN or
1896 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1901 <column name="status">
1902 <p>Key-value pairs that report controller status.</p>
1904 <dt><code>last_error</code></dt>
1905 <dd>A human-readable description of the last error on the connection
1906 to the controller; i.e. <code>strerror(errno)</code>. This key
1907 will exist only if an error has occurred.</dd>
1910 <dt><code>state</code></dt>
1911 <dd>The state of the connection to the controller. Possible values
1912 are: <code>VOID</code>, <code>BACKOFF</code>,
1913 <code>CONNECTING</code>, <code>ACTIVE</code>, and
1914 <code>IDLE</code>.</dd>
1917 <dt><code>time_in_state</code></dt>
1918 <dd>Seconds since connecting to (if currently connected) or
1919 disconnecting from (if currently disconnected) this
1926 <table name="Manager" title="OVSDB management connection.">
1928 Configuration for a database connection to an Open vSwitch database
1933 This table primarily configures the Open vSwitch database
1934 (<code>ovsdb-server</code>), not the Open vSwitch switch
1935 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1936 what connections should be treated as in-band.
1940 The Open vSwitch database server can initiate and maintain active
1941 connections to remote clients. It can also listen for database
1945 <group title="Core Features">
1946 <column name="target">
1947 <p>Connection method for managers.</p>
1949 The following connection methods are currently supported:
1952 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1955 The specified SSL <var>port</var> (default: 6632) on the host at
1956 the given <var>ip</var>, which must be expressed as an IP address
1957 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1958 column in the <ref table="Open_vSwitch"/> table must point to a
1959 valid SSL configuration when this form is used.
1962 SSL support is an optional feature that is not always built as
1963 part of Open vSwitch.
1967 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1969 The specified TCP <var>port</var> (default: 6632) on the host at
1970 the given <var>ip</var>, which must be expressed as an IP address
1973 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1976 Listens for SSL connections on the specified TCP <var>port</var>
1977 (default: 6632). If <var>ip</var>, which must be expressed as an
1978 IP address (not a DNS name), is specified, then connections are
1979 restricted to the specified local IP address.
1982 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1983 table="Open_vSwitch"/> table must point to a valid SSL
1984 configuration when this form is used.
1987 SSL support is an optional feature that is not always built as
1988 part of Open vSwitch.
1991 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1993 Listens for connections on the specified TCP <var>port</var>
1994 (default: 6632). If <var>ip</var>, which must be expressed as an
1995 IP address (not a DNS name), is specified, then connections are
1996 restricted to the specified local IP address.
1999 <p>When multiple managers are configured, the <ref column="target"/>
2000 values must be unique. Duplicate <ref column="target"/> values yield
2001 unspecified results.</p>
2004 <column name="connection_mode">
2006 If it is specified, this setting must be one of the following strings
2007 that describes how Open vSwitch contacts this OVSDB client over the
2012 <dt><code>in-band</code></dt>
2014 In this mode, this connection's traffic travels over a bridge
2015 managed by Open vSwitch. With this setting, Open vSwitch allows
2016 traffic to and from the client regardless of the contents of the
2017 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2018 to connect to the client, because it did not have a flow to enable
2019 it.) This is the most common connection mode because it is not
2020 necessary to maintain two independent networks.
2022 <dt><code>out-of-band</code></dt>
2024 In this mode, the client's traffic uses a control network separate
2025 from that managed by Open vSwitch, that is, Open vSwitch does not
2026 use any of its own network devices to communicate with the client.
2027 The control network must be configured separately, before or after
2028 <code>ovs-vswitchd</code> is started.
2033 If not specified, the default is implementation-specific.
2038 <group title="Client Failure Detection and Handling">
2039 <column name="max_backoff">
2040 Maximum number of milliseconds to wait between connection attempts.
2041 Default is implementation-specific.
2044 <column name="inactivity_probe">
2045 Maximum number of milliseconds of idle time on connection to the client
2046 before sending an inactivity probe message. If Open vSwitch does not
2047 communicate with the client for the specified number of seconds, it
2048 will send a probe. If a response is not received for the same
2049 additional amount of time, Open vSwitch assumes the connection has been
2050 broken and attempts to reconnect. Default is implementation-specific.
2054 <group title="Other Features">
2055 <column name="external_ids">
2056 Key-value pairs for use by external frameworks that integrate with Open
2057 vSwitch, rather than by Open vSwitch itself. System integrators should
2058 either use the Open vSwitch development mailing list to coordinate on
2059 common key-value definitions, or choose key names that are likely to be
2060 unique. No common key-value pairs are currently defined.
2064 <group title="Status">
2065 <column name="is_connected">
2066 <code>true</code> if currently connected to this manager,
2067 <code>false</code> otherwise.
2070 <column name="status">
2071 <p>Key-value pairs that report manager status.</p>
2073 <dt><code>last_error</code></dt>
2074 <dd>A human-readable description of the last error on the connection
2075 to the manager; i.e. <code>strerror(errno)</code>. This key
2076 will exist only if an error has occurred.</dd>
2079 <dt><code>state</code></dt>
2080 <dd>The state of the connection to the manager. Possible values
2081 are: <code>VOID</code> (connection is disabled),
2082 <code>BACKOFF</code> (attempting to reconnect at an increasing
2083 period), <code>CONNECT_IN_PROGRESS</code> (attempting to connect),
2084 <code>ACTIVE</code> (connected, remote host responsive), and
2085 <code>IDLE</code> (remote host unresponsive, disconnecting). These
2086 values may change in the future. They are provided only for human
2090 <dt><code>time_in_state</code></dt>
2091 <dd>Milliseconds since the <code>state</code> key changed.</dd>
2097 <table name="NetFlow">
2098 A NetFlow target. NetFlow is a protocol that exports a number of
2099 details about terminating IP flows, such as the principals involved
2102 <column name="targets">
2103 NetFlow targets in the form
2104 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2105 must be specified numerically, not as a DNS name.
2108 <column name="engine_id">
2109 Engine ID to use in NetFlow messages. Defaults to datapath index
2113 <column name="engine_type">
2114 Engine type to use in NetFlow messages. Defaults to datapath
2115 index if not specified.
2118 <column name="active_timeout">
2119 The interval at which NetFlow records are sent for flows that are
2120 still active, in seconds. A value of <code>0</code> requests the
2121 default timeout (currently 600 seconds); a value of <code>-1</code>
2122 disables active timeouts.
2125 <column name="add_id_to_interface">
2126 <p>If this column's value is <code>false</code>, the ingress and egress
2127 interface fields of NetFlow flow records are derived from OpenFlow port
2128 numbers. When it is <code>true</code>, the 7 most significant bits of
2129 these fields will be replaced by the least significant 7 bits of the
2130 engine id. This is useful because many NetFlow collectors do not
2131 expect multiple switches to be sending messages from the same host, so
2132 they do not store the engine information which could be used to
2133 disambiguate the traffic.</p>
2134 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2137 <column name="external_ids">
2138 Key-value pairs for use by external frameworks that integrate with Open
2139 vSwitch, rather than by Open vSwitch itself. System integrators should
2140 either use the Open vSwitch development mailing list to coordinate on
2141 common key-value definitions, or choose key names that are likely to be
2142 unique. No common key-value pairs are currently defined.
2147 SSL configuration for an Open_vSwitch.
2149 <column name="private_key">
2150 Name of a PEM file containing the private key used as the switch's
2151 identity for SSL connections to the controller.
2154 <column name="certificate">
2155 Name of a PEM file containing a certificate, signed by the
2156 certificate authority (CA) used by the controller and manager,
2157 that certifies the switch's private key, identifying a trustworthy
2161 <column name="ca_cert">
2162 Name of a PEM file containing the CA certificate used to verify
2163 that the switch is connected to a trustworthy controller.
2166 <column name="bootstrap_ca_cert">
2167 If set to <code>true</code>, then Open vSwitch will attempt to
2168 obtain the CA certificate from the controller on its first SSL
2169 connection and save it to the named PEM file. If it is successful,
2170 it will immediately drop the connection and reconnect, and from then
2171 on all SSL connections must be authenticated by a certificate signed
2172 by the CA certificate thus obtained. <em>This option exposes the
2173 SSL connection to a man-in-the-middle attack obtaining the initial
2174 CA certificate.</em> It may still be useful for bootstrapping.
2177 <column name="external_ids">
2178 Key-value pairs for use by external frameworks that integrate with Open
2179 vSwitch, rather than by Open vSwitch itself. System integrators should
2180 either use the Open vSwitch development mailing list to coordinate on
2181 common key-value definitions, or choose key names that are likely to be
2182 unique. No common key-value pairs are currently defined.
2186 <table name="sFlow">
2187 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2190 <column name="agent">
2191 Name of the network device whose IP address should be reported as the
2192 ``agent address'' to collectors. If not specified, the IP address
2193 defaults to the <ref table="Controller" column="local_ip"/> in the
2194 collector's <ref table="Controller"/>. If an agent IP address cannot be
2195 determined either way, sFlow is disabled.
2198 <column name="header">
2199 Number of bytes of a sampled packet to send to the collector.
2200 If not specified, the default is 128 bytes.
2203 <column name="polling">
2204 Polling rate in seconds to send port statistics to the collector.
2205 If not specified, defaults to 30 seconds.
2208 <column name="sampling">
2209 Rate at which packets should be sampled and sent to the collector.
2210 If not specified, defaults to 400, which means one out of 400
2211 packets, on average, will be sent to the collector.
2214 <column name="targets">
2215 sFlow targets in the form
2216 <code><var>ip</var>:<var>port</var></code>.
2219 <column name="external_ids">
2220 Key-value pairs for use by external frameworks that integrate with Open
2221 vSwitch, rather than by Open vSwitch itself. System integrators should
2222 either use the Open vSwitch development mailing list to coordinate on
2223 common key-value definitions, or choose key names that are likely to be
2224 unique. No common key-value pairs are currently defined.
2228 <table name="Capability">
2229 <p>Records in this table describe functionality supported by the hardware
2230 and software platform on which this Open vSwitch is based. Clients
2231 should not modify this table.</p>
2233 <p>A record in this table is meaningful only if it is referenced by the
2234 <ref table="Open_vSwitch" column="capabilities"/> column in the
2235 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2236 the record's ``category,'' determines the meanings of the
2237 <ref column="details"/> column. The following general forms of
2238 categories are currently defined:</p>
2241 <dt><code>qos-<var>type</var></code></dt>
2242 <dd><var>type</var> is supported as the value for
2243 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2247 <column name="details">
2248 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2249 depends on the category key that the <ref table="Open_vSwitch"
2250 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2251 uses to reference this record, as described above.</p>
2253 <p>The presence of a record for category <code>qos-<var>type</var></code>
2254 indicates that the switch supports <var>type</var> as the value of
2255 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2256 table. The following key-value pairs are defined to further describe
2257 QoS capabilities:</p>
2260 <dt><code>n-queues</code></dt>
2261 <dd>Number of supported queues, as a positive integer. Keys in the
2262 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2263 records whose <ref table="QoS" column="type"/> value
2264 equals <var>type</var> must range between 0 and this value minus one,
projects / openvswitch / blob