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
12 ``root set'' tables noted below.
15 <table name="Open_vSwitch" title="Open vSwitch configuration.">
16 Configuration for an Open vSwitch daemon. There must be exactly
17 one record in the <ref table="Open_vSwitch"/> table.
19 <group title="Configuration">
20 <column name="bridges">
21 Set of bridges managed by the daemon.
25 SSL used globally by the daemon.
28 <column name="other_config">
29 Key-value pairs for configuring rarely used Open vSwitch features. The
30 currently defined key-value pairs are:
32 <dt><code>enable-statistics</code></dt>
34 Set to <code>true</code> to enable populating the <ref
35 column="statistics"/> column or <code>false</code> (the default)
36 disable populating it.
41 <column name="external_ids">
42 Key-value pairs for use by external frameworks that integrate
43 with Open vSwitch, rather than by Open vSwitch itself. System
44 integrators should either use the Open vSwitch development
45 mailing list to coordinate on common key-value definitions, or
46 choose key names that are likely to be unique. The currently
47 defined common key-value pairs are:
49 <dt><code>system-id</code></dt>
50 <dd>A unique identifier for the Open vSwitch's physical host.
51 The form of the identifier depends on the type of the host.
52 On a Citrix XenServer, this will likely be the same as
53 <code>xs-system-uuid</code>.</dd>
54 <dt><code>xs-system-uuid</code></dt>
55 <dd>The Citrix XenServer universally unique identifier for the
56 physical host as displayed by <code>xe host-list</code>.</dd>
61 <group title="Status">
62 <column name="next_cfg">
63 Sequence number for client to increment. When a client modifies
64 any part of the database configuration and wishes to wait for
65 Open vSwitch to finish applying the changes, it may increment
69 <column name="cur_cfg">
70 Sequence number that Open vSwitch sets to the current value of
71 <ref column="next_cfg"/> after it finishes applying a set of
72 configuration changes.
75 <column name="capabilities">
76 Describes functionality supported by the hardware and software platform
77 on which this Open vSwitch is based. Clients should not modify this
78 column. See the <ref table="Capability"/> description for defined
79 capability categories and the meaning of associated
80 <ref table="Capability"/> records.
83 <column name="statistics">
85 Key-value pairs that report statistics about a system running an Open
86 vSwitch. These are updated periodically (currently, every 5
87 seconds). Key-value pairs that cannot be determined or that do not
88 apply to a platform are omitted.
92 Statistics are disabled unless <ref column="other-config"
93 key="enable-statistics"/> is set to <code>true</code>.
97 <dt><code>cpu</code></dt>
100 Number of CPU processors, threads, or cores currently online and
101 available to the operating system on which Open vSwitch is
102 running, as an integer. This may be less than the number
103 installed, if some are not online or if they are not available to
104 the operating system.
107 Open vSwitch userspace processes are not multithreaded, but the
108 Linux kernel-based datapath is.
112 <dt><code>load_average</code></dt>
115 A comma-separated list of three floating-point numbers,
116 representing the system load average over the last 1, 5, and 15
117 minutes, respectively.
121 <dt><code>memory</code></dt>
124 A comma-separated list of integers, each of which represents a
125 quantity of memory in kilobytes that describes the operating
126 system on which Open vSwitch is running. In respective order,
131 <li>Total amount of RAM allocated to the OS.</li>
132 <li>RAM allocated to the OS that is in use.</li>
133 <li>RAM that can be flushed out to disk or otherwise discarded
134 if that space is needed for another purpose. This number is
135 necessarily less than or equal to the previous value.</li>
136 <li>Total disk space allocated for swap.</li>
137 <li>Swap space currently in use.</li>
141 On Linux, all five values can be determined and are included. On
142 other operating systems, only the first two values can be
143 determined, so the list will only have two values.
147 <dt><code>process_</code><var>name</var></dt>
150 One such key-value pair will exist for each running Open vSwitch
151 daemon process, with <var>name</var> replaced by the daemon's
152 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
153 comma-separated list of integers. The integers represent the
154 following, with memory measured in kilobytes and durations in
159 <li>The process's virtual memory size.</li>
160 <li>The process's resident set size.</li>
161 <li>The amount of user and system CPU time consumed by the
163 <li>The number of times that the process has crashed and been
164 automatically restarted by the monitor.</li>
165 <li>The duration since the process was started.</li>
166 <li>The duration for which the process has been running.</li>
170 The interpretation of some of these values depends on whether the
171 process was started with the <option>--monitor</option>. If it
172 was not, then the crash count will always be 0 and the two
173 durations will always be the same. If <option>--monitor</option>
174 was given, then the crash count may be positive; if it is, the
175 latter duration is the amount of time since the most recent crash
180 There will be one key-value pair for each file in Open vSwitch's
181 ``run directory'' (usually <code>/var/run/openvswitch</code>)
182 whose name ends in <code>.pid</code>, whose contents are a
183 process ID, and which is locked by a running process. The
184 <var>name</var> is taken from the pidfile's name.
188 Currently Open vSwitch is only able to obtain all of the above
189 detail on Linux systems. On other systems, the same key-value
190 pairs will be present but the values will always be the empty
195 <dt><code>file_systems</code></dt>
198 A space-separated list of information on local, writable file
199 systems. Each item in the list describes one file system and
200 consists in turn of a comma-separated list of the following:
204 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
205 Any spaces or commas in the mount point are replaced by
207 <li>Total size, in kilobytes, as an integer.</li>
208 <li>Amount of storage in use, in kilobytes, as an integer.</li>
212 This key-value pair is omitted if there are no local, writable
213 file systems or if Open vSwitch cannot obtain the needed
221 <group title="Version Reporting">
223 These columns report the types and versions of the hardware and
224 software running Open vSwitch. We recommend in general that software
225 should test whether specific features are supported instead of relying
226 on version number checks. These values are primarily intended for
227 reporting to human administrators.
230 <column name="ovs_version">
231 The Open vSwitch version number, e.g. <code>1.1.0pre2</code>.
232 If Open vSwitch was configured with a build number, then it is
233 also included, e.g. <code>1.1.0pre2+build4948</code>.
236 <column name="db_version">
238 The database schema version number in the form
239 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
240 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
241 a non-backward compatible way (e.g. deleting a column or a table),
242 <var>major</var> is incremented. When the database schema is changed
243 in a backward compatible way (e.g. adding a new column),
244 <var>minor</var> is incremented. When the database schema is changed
245 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
250 The schema version is part of the database schema, so it can also be
251 retrieved by fetching the schema using the Open vSwitch database
256 <column name="system_type">
258 An identifier for the type of system on top of which Open vSwitch
259 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
262 System integrators are responsible for choosing and setting an
263 appropriate value for this column.
267 <column name="system_version">
269 The version of the system identified by <ref column="system_type"/>,
270 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
273 System integrators are responsible for choosing and setting an
274 appropriate value for this column.
280 <group title="Database Configuration">
282 These columns primarily configure the Open vSwitch database
283 (<code>ovsdb-server</code>), not the Open vSwitch switch
284 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
285 column="ssl"/> settings.
289 The Open vSwitch switch does read the database configuration to
290 determine remote IP addresses to which in-band control should apply.
293 <column name="manager_options">
294 Database clients to which the Open vSwitch database server should
295 connect or to which it should listen, along with options for how these
296 connection should be configured. See the <ref table="Manager"/> table
297 for more information.
302 <table name="Bridge">
304 Configuration for a bridge within an
305 <ref table="Open_vSwitch"/>.
308 A <ref table="Bridge"/> record represents an Ethernet switch with one or
309 more ``ports,'' which are the <ref table="Port"/> records pointed to by
310 the <ref table="Bridge"/>'s <ref column="ports"/> column.
313 <group title="Core Features">
315 Bridge identifier. Should be alphanumeric and no more than about 8
316 bytes long. Must be unique among the names of ports, interfaces, and
320 <column name="ports">
321 Ports included in the bridge.
324 <column name="mirrors">
325 Port mirroring configuration.
328 <column name="netflow">
329 NetFlow configuration.
332 <column name="sflow">
336 <column name="flood_vlans">
337 VLAN IDs of VLANs on which MAC address learning should be disabled, so
338 that packets are flooded instead of being sent to specific ports that
339 are believed to contain packets' destination MACs. This should
340 ordinarily be used to disable MAC learning on VLANs used for mirroring
341 (RSPAN VLANs). It may also be useful for debugging.
345 <group title="OpenFlow Configuration">
346 <column name="controller">
347 OpenFlow controller set. If unset, then no OpenFlow controllers
351 <column name="fail_mode">
352 <p>When a controller is configured, it is, ordinarily, responsible
353 for setting up all flows on the switch. Thus, if the connection to
354 the controller fails, no new network connections can be set up.
355 If the connection to the controller stays down long enough,
356 no packets can pass through the switch at all. This setting
357 determines the switch's response to such a situation. It may be set
358 to one of the following:
360 <dt><code>standalone</code></dt>
361 <dd>If no message is received from the controller for three
362 times the inactivity probe interval
363 (see <ref column="inactivity_probe"/>), then Open vSwitch
364 will take over responsibility for setting up flows. In
365 this mode, Open vSwitch causes the bridge to act like an
366 ordinary MAC-learning switch. Open vSwitch will continue
367 to retry connecting to the controller in the background
368 and, when the connection succeeds, it will discontinue its
369 standalone behavior.</dd>
370 <dt><code>secure</code></dt>
371 <dd>Open vSwitch will not set up flows on its own when the
372 controller connection fails or when no controllers are
373 defined. The bridge will continue to retry connecting to
374 any defined controllers forever.</dd>
377 <p>If this value is unset, the default is implementation-specific.</p>
378 <p>When more than one controller is configured,
379 <ref column="fail_mode"/> is considered only when none of the
380 configured controllers can be contacted.</p>
383 <column name="datapath_id">
384 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
385 (Setting this column has no useful effect. Set <ref
386 column="other-config" key="datapath-id"/> instead.)
390 <group title="Other Features">
391 <column name="datapath_type">
392 Name of datapath provider. The kernel datapath has
393 type <code>system</code>. The userspace datapath has
394 type <code>netdev</code>.
397 <column name="external_ids">
398 Key-value pairs for use by external frameworks that integrate
399 with Open vSwitch, rather than by Open vSwitch itself. System
400 integrators should either use the Open vSwitch development
401 mailing list to coordinate on common key-value definitions, or
402 choose key names that are likely to be unique. The currently
403 defined key-value pairs are:
405 <dt><code>bridge-id</code></dt>
406 <dd>A unique identifier of the bridge. On Citrix XenServer this
407 will commonly be the same as <code>xs-network-uuids</code>.</dd>
408 <dt><code>xs-network-uuids</code></dt>
409 <dd>Semicolon-delimited set of universally unique identifier(s) for
410 the network with which this bridge is associated on a Citrix
411 XenServer host. The network identifiers are RFC 4122 UUIDs as
412 displayed by, e.g., <code>xe network-list</code>.</dd>
416 <column name="other_config">
417 Key-value pairs for configuring rarely used bridge
418 features. The currently defined key-value pairs are:
420 <dt><code>datapath-id</code></dt>
422 digits to set the OpenFlow datapath ID to a specific
423 value. May not be all-zero.</dd>
424 <dt><code>disable-in-band</code></dt>
425 <dd>If set to <code>true</code>, disable in-band control on
426 the bridge regardless of controller and manager settings.</dd>
427 <dt><code>hwaddr</code></dt>
428 <dd>An Ethernet address in the form
429 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
430 to set the hardware address of the local port and influence the
432 <dt><code>in-band-queue</code></dt>
434 A queue ID as a nonnegative integer. This sets the OpenFlow queue
435 ID that will be used by flows set up by in-band control on this
436 bridge. If unset, or if the port used by an in-band control flow
437 does not have QoS configured, or if the port does not have a queue
438 with the specified ID, the default queue is used instead.
445 <table name="Port" table="Port or bond configuration.">
446 <p>A port within a <ref table="Bridge"/>.</p>
447 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
448 <ref column="interfaces"/> column. Such a port logically
449 corresponds to a port on a physical Ethernet switch. A port
450 with more than one interface is a ``bonded port'' (see
451 <ref group="Bonding Configuration"/>).</p>
452 <p>Some properties that one might think as belonging to a port are actually
453 part of the port's <ref table="Interface"/> members.</p>
456 Port name. Should be alphanumeric and no more than about 8
457 bytes long. May be the same as the interface name, for
458 non-bonded ports. Must otherwise be unique among the names of
459 ports, interfaces, and bridges on a host.
462 <column name="interfaces">
463 The port's interfaces. If there is more than one, this is a
467 <group title="VLAN Configuration">
468 <p>A bridge port must be configured for VLANs in one of two
469 mutually exclusive ways:
471 <li>A ``trunk port'' has an empty value for <ref
472 column="tag"/>. Its <ref column="trunks"/> value may be
473 empty or non-empty.</li>
474 <li>An ``implicitly tagged VLAN port'' or ``access port''
475 has an nonempty value for <ref column="tag"/>. Its
476 <ref column="trunks"/> value must be empty.</li>
478 If <ref column="trunks"/> and <ref column="tag"/> are both
479 nonempty, the configuration is ill-formed.
484 If this is an access port (see above), the port's implicitly
485 tagged VLAN. Must be empty if this is a trunk port.
488 Frames arriving on trunk ports will be forwarded to this
489 port only if they are tagged with the given VLAN (or, if
490 <ref column="tag"/> is 0, then if they lack a VLAN header).
491 Frames arriving on other access ports will be forwarded to
492 this port only if they have the same <ref column="tag"/>
493 value. Frames forwarded to this port will not have an
497 When a frame with a 802.1Q header that indicates a nonzero
498 VLAN is received on an access port, it is discarded.
502 <column name="trunks">
504 If this is a trunk port (see above), the 802.1Q VLAN(s) that
505 this port trunks; if it is empty, then the port trunks all
506 VLANs. Must be empty if this is an access port.
509 Frames arriving on trunk ports are dropped if they are not
510 in one of the specified VLANs. For this purpose, packets
511 that have no VLAN header are treated as part of VLAN 0.
516 <group title="Bonding Configuration">
517 <p>A port that has more than one interface is a ``bonded port.'' Bonding
518 allows for load balancing and fail-over. Some kinds of bonding will
519 work with any kind of upstream switch:</p>
522 <dt><code>balance-slb</code></dt>
524 Balances flows among slaves based on source MAC address and output
525 VLAN, with periodic rebalancing as traffic patterns change.
528 <dt><code>active-backup</code></dt>
530 Assigns all flows to one slave, failing over to a backup slave when
531 the active slave is disabled.
536 The following mode requires the upstream switch to support 802.3ad with
537 successful LACP negotiation. If LACP negotiation fails then
538 <code>balance-slb</code> mode is used as a fallback:
542 <dt><code>balance-tcp</code></dt>
544 Balances flows among slaves based on L2, L3, and L4 protocol
545 information such as destination MAC address, IP address, and TCP
550 <p>These columns apply only to bonded ports. Their values are
551 otherwise ignored.</p>
553 <column name="bond_mode">
554 <p>The type of bonding used for a bonded port. Defaults to
555 <code>balance-slb</code> if unset.
559 <column name="bond_updelay">
560 <p>For a bonded port, the number of milliseconds for which carrier must
561 stay up on an interface before the interface is considered to be up.
562 Specify <code>0</code> to enable the interface immediately.</p>
563 <p>This setting is honored only when at least one bonded interface is
564 already enabled. When no interfaces are enabled, then the first bond
565 interface to come up is enabled immediately.</p>
568 <column name="bond_downdelay">
569 For a bonded port, the number of milliseconds for which carrier must
570 stay down on an interface before the interface is considered to be
571 down. Specify <code>0</code> to disable the interface immediately.
574 <column name="bond_fake_iface">
575 For a bonded port, whether to create a fake internal interface with the
576 name of the port. Use only for compatibility with legacy software that
581 <p>Configures LACP on this port. LACP allows directly connected
582 switches to negotiate which links may be bonded. LACP may be enabled
583 on non-bonded ports for the benefit of any switches they may be
584 connected to. <code>active</code> ports are allowed to initiate LACP
585 negotiations. <code>passive</code> ports are allowed to participate
586 in LACP negotiations initiated by a remote switch, but not allowed to
587 initiate such negotiations themselves. If unset Open vSwitch will
588 choose a reasonable default. </p>
593 <group title="Other Features">
595 Quality of Service configuration for this port.
599 The MAC address to use for this port for the purpose of choosing the
600 bridge's MAC address. This column does not necessarily reflect the
601 port's actual MAC address, nor will setting it change the port's actual
605 <column name="fake_bridge">
606 Does this port represent a sub-bridge for its tagged VLAN within the
607 Bridge? See ovs-vsctl(8) for more information.
610 <column name="external_ids">
612 Key-value pairs for use by external frameworks that integrate with
613 Open vSwitch, rather than by Open vSwitch itself. System integrators
614 should either use the Open vSwitch development mailing list to
615 coordinate on common key-value definitions, or choose key names that
616 are likely to be unique.
619 No key-value pairs native to <ref table="Port"/> are currently
620 defined. For fake bridges (see the <ref column="fake_bridge"/>
621 column), external IDs for the fake bridge are defined here by
622 prefixing a <ref table="Bridge"/> <ref table="Bridge"
623 column="external_ids"/> key with <code>fake-bridge-</code>,
624 e.g. <code>fake-bridge-xs-network-uuids</code>.
628 <column name="other_config">
629 Key-value pairs for configuring rarely used port features. The
630 currently defined key-value pairs are:
632 <dt><code>hwaddr</code></dt>
633 <dd>An Ethernet address in the form
634 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
635 <dt><code>bond-rebalance-interval</code></dt>
636 <dd>For an SLB bonded port, the number of milliseconds between
637 successive attempts to rebalance the bond, that is, to
638 move source MACs and their flows from one interface on
639 the bond to another in an attempt to keep usage of each
640 interface roughly equal. The default is 10000 (10
641 seconds), and the minimum is 1000 (1 second).</dd>
642 <dt><code>bond-detect-mode</code></dt>
643 <dd> Sets the method used to detect link failures in a bonded port.
644 Options are <code>carrier</code> and <code>miimon</code>. Defaults
645 to <code>carrier</code> which uses each interface's carrier to detect
646 failures. When set to <code>miimon</code>, will check for failures
647 by polling each interface's MII. </dd>
648 <dt><code>bond-miimon-interval</code></dt>
649 <dd> The number of milliseconds between successive attempts to
650 poll each interface's MII. Only relevant on ports which use
651 <code>miimon</code> to detect failures. </dd>
652 <dt><code>lacp-system-priority</code></dt>
653 <dd> The LACP system priority of this <ref table="Port"/>. In
654 LACP negotiations, link status decisions are made by the system
655 with the numerically lower priority. Must be a number between 1
662 <table name="Interface" title="One physical network device in a Port.">
663 An interface within a <ref table="Port"/>.
665 <group title="Core Features">
667 Interface name. Should be alphanumeric and no more than about 8 bytes
668 long. May be the same as the port name, for non-bonded ports. Must
669 otherwise be unique among the names of ports, interfaces, and bridges
674 <p>Ethernet address to set for this interface. If unset then the
675 default MAC address is used:</p>
677 <li>For the local interface, the default is the lowest-numbered MAC
678 address among the other bridge ports, either the value of the
679 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
680 if set, or its actual MAC (for bonded ports, the MAC of its slave
681 whose name is first in alphabetical order). Internal ports and
682 bridge ports that are used as port mirroring destinations (see the
683 <ref table="Mirror"/> table) are ignored.</li>
684 <li>For other internal interfaces, the default MAC is randomly
686 <li>External interfaces typically have a MAC address associated with
689 <p>Some interfaces may not have a software-controllable MAC
693 <column name="ofport">
694 <p>OpenFlow port number for this interface. Unlike most columns, this
695 column's value should be set only by Open vSwitch itself. Other
696 clients should set this column to an empty set (the default) when
697 creating an <ref table="Interface"/>.</p>
698 <p>Open vSwitch populates this column when the port number becomes
699 known. If the interface is successfully added,
700 <ref column="ofport"/> will be set to a number between 1 and 65535
701 (generally either in the range 1 to 65279, inclusive, or 65534, the
702 port number for the OpenFlow ``local port''). If the interface
703 cannot be added then Open vSwitch sets this column
708 <group title="System-Specific Details">
710 The interface type, one of:
712 <dt><code>system</code></dt>
713 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
714 Sometimes referred to as ``external interfaces'' since they are
715 generally connected to hardware external to that on which the Open
716 vSwitch is running. The empty string is a synonym for
717 <code>system</code>.</dd>
718 <dt><code>internal</code></dt>
719 <dd>A simulated network device that sends and receives traffic. An
720 internal interface whose <ref column="name"/> is the same as its
721 bridge's <ref table="Open_vSwitch" column="name"/> is called the
722 ``local interface.'' It does not make sense to bond an internal
723 interface, so the terms ``port'' and ``interface'' are often used
724 imprecisely for internal interfaces.</dd>
725 <dt><code>tap</code></dt>
726 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
727 <dt><code>gre</code></dt>
728 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
729 tunnel. Each tunnel must be uniquely identified by the
730 combination of <code>remote_ip</code>, <code>local_ip</code>, and
731 <code>in_key</code>. Note that if two ports are defined that are
732 the same except one has an optional identifier and the other does
733 not, the more specific one is matched first. <code>in_key</code>
734 is considered more specific than <code>local_ip</code> if a port
735 defines one and another port defines the other. The following
736 options may be specified in the <ref column="options"/> column:
738 <dt><code>remote_ip</code></dt>
739 <dd>Required. The tunnel endpoint.</dd>
742 <dt><code>local_ip</code></dt>
743 <dd>Optional. The destination IP that received packets must
744 match. Default is to match all addresses.</dd>
747 <dt><code>in_key</code></dt>
748 <dd>Optional. The GRE key that received packets must contain.
749 It may either be a 32-bit number (no key and a key of 0 are
750 treated as equivalent) or the word <code>flow</code>. If
751 <code>flow</code> is specified then any key will be accepted
752 and the key will be placed in the <code>tun_id</code> field
753 for matching in the flow table. The ovs-ofctl manual page
754 contains additional information about matching fields in
755 OpenFlow flows. Default is no key.</dd>
758 <dt><code>out_key</code></dt>
759 <dd>Optional. The GRE key to be set on outgoing packets. It may
760 either be a 32-bit number or the word <code>flow</code>. If
761 <code>flow</code> is specified then the key may be set using
762 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
763 is used in the absence of an action). The ovs-ofctl manual
764 page contains additional information about the Nicira OpenFlow
765 vendor extensions. Default is no key.</dd>
768 <dt><code>key</code></dt>
769 <dd>Optional. Shorthand to set <code>in_key</code> and
770 <code>out_key</code> at the same time.</dd>
773 <dt><code>tos</code></dt>
774 <dd>Optional. The value of the ToS bits to be set on the
775 encapsulating packet. It may also be the word
776 <code>inherit</code>, in which case the ToS will be copied from
777 the inner packet if it is IPv4 or IPv6 (otherwise it will be
778 0). Note that the ECN fields are always inherited. Default is
782 <dt><code>ttl</code></dt>
783 <dd>Optional. The TTL to be set on the encapsulating packet.
784 It may also be the word <code>inherit</code>, in which case the
785 TTL will be copied from the inner packet if it is IPv4 or IPv6
786 (otherwise it will be the system default, typically 64).
787 Default is the system default TTL.</dd>
790 <dt><code>csum</code></dt>
791 <dd>Optional. Compute GRE checksums on outgoing packets.
792 Checksums present on incoming packets will be validated
793 regardless of this setting. Note that GRE checksums
794 impose a significant performance penalty as they cover the
795 entire packet. As the contents of the packet is typically
796 covered by L3 and L4 checksums, this additional checksum only
797 adds value for the GRE and encapsulated Ethernet headers.
798 Default is disabled, set to <code>true</code> to enable.</dd>
801 <dt><code>pmtud</code></dt>
802 <dd>Optional. Enable tunnel path MTU discovery. If enabled
803 ``ICMP destination unreachable - fragmentation'' needed
804 messages will be generated for IPv4 packets with the DF bit set
805 and IPv6 packets above the minimum MTU if the packet size
806 exceeds the path MTU minus the size of the tunnel headers. It
807 also forces the encapsulating packet DF bit to be set (it is
808 always set if the inner packet implies path MTU discovery).
809 Note that this option causes behavior that is typically
810 reserved for routers and therefore is not entirely in
811 compliance with the IEEE 802.1D specification for bridges.
812 Default is enabled, set to <code>false</code> to disable.</dd>
815 <dt><code>header_cache</code></dt>
816 <dd>Optional. Enable caching of tunnel headers and the output
817 path. This can lead to a significant performance increase
818 without changing behavior. In general it should not be
819 necessary to adjust this setting. However, the caching can
820 bypass certain components of the IP stack (such as IP tables)
821 and it may be useful to disable it if these features are
822 required or as a debugging measure. Default is enabled, set to
823 <code>false</code> to disable.</dd>
826 <dt><code>ipsec_gre</code></dt>
827 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
828 over IPv4 IPsec tunnel. Each tunnel (including those of type
829 <code>gre</code>) must be uniquely identified by the
830 combination of <code>remote_ip</code> and
831 <code>local_ip</code>. Note that if two ports are defined
832 that are the same except one has an optional identifier and
833 the other does not, the more specific one is matched first.
834 An authentication method of <code>peer_cert</code> or
835 <code>psk</code> must be defined. The following options may
836 be specified in the <ref column="options"/> column:
838 <dt><code>remote_ip</code></dt>
839 <dd>Required. The tunnel endpoint.</dd>
842 <dt><code>local_ip</code></dt>
843 <dd>Optional. The destination IP that received packets must
844 match. Default is to match all addresses.</dd>
847 <dt><code>peer_cert</code></dt>
848 <dd>Required for certificate authentication. A string
849 containing the peer's certificate in PEM format.
850 Additionally the host's certificate must be specified
851 with the <code>certificate</code> option.</dd>
854 <dt><code>certificate</code></dt>
855 <dd>Required for certificate authentication. The name of a
856 PEM file containing a certificate that will be presented
857 to the peer during authentication.</dd>
860 <dt><code>private_key</code></dt>
861 <dd>Optional for certificate authentication. The name of
862 a PEM file containing the private key associated with
863 <code>certificate</code>. If <code>certificate</code>
864 contains the private key, this option may be omitted.</dd>
867 <dt><code>psk</code></dt>
868 <dd>Required for pre-shared key authentication. Specifies a
869 pre-shared key for authentication that must be identical on
870 both sides of the tunnel.</dd>
873 <dt><code>in_key</code></dt>
874 <dd>Optional. The GRE key that received packets must contain.
875 It may either be a 32-bit number (no key and a key of 0 are
876 treated as equivalent) or the word <code>flow</code>. If
877 <code>flow</code> is specified then any key will be accepted
878 and the key will be placed in the <code>tun_id</code> field
879 for matching in the flow table. The ovs-ofctl manual page
880 contains additional information about matching fields in
881 OpenFlow flows. Default is no key.</dd>
884 <dt><code>out_key</code></dt>
885 <dd>Optional. The GRE key to be set on outgoing packets. It may
886 either be a 32-bit number or the word <code>flow</code>. If
887 <code>flow</code> is specified then the key may be set using
888 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
889 is used in the absence of an action). The ovs-ofctl manual
890 page contains additional information about the Nicira OpenFlow
891 vendor extensions. Default is no key.</dd>
894 <dt><code>key</code></dt>
895 <dd>Optional. Shorthand to set <code>in_key</code> and
896 <code>out_key</code> at the same time.</dd>
899 <dt><code>tos</code></dt>
900 <dd>Optional. The value of the ToS bits to be set on the
901 encapsulating packet. It may also be the word
902 <code>inherit</code>, in which case the ToS will be copied from
903 the inner packet if it is IPv4 or IPv6 (otherwise it will be
904 0). Note that the ECN fields are always inherited. Default is
908 <dt><code>ttl</code></dt>
909 <dd>Optional. The TTL to be set on the encapsulating packet.
910 It may also be the word <code>inherit</code>, in which case the
911 TTL will be copied from the inner packet if it is IPv4 or IPv6
912 (otherwise it will be the system default, typically 64).
913 Default is the system default TTL.</dd>
916 <dt><code>csum</code></dt>
917 <dd>Optional. Compute GRE checksums on outgoing packets.
918 Checksums present on incoming packets will be validated
919 regardless of this setting. Note that GRE checksums
920 impose a significant performance penalty as they cover the
921 entire packet. As the contents of the packet is typically
922 covered by L3 and L4 checksums, this additional checksum only
923 adds value for the GRE and encapsulated Ethernet headers.
924 Default is disabled, set to <code>true</code> to enable.</dd>
927 <dt><code>pmtud</code></dt>
928 <dd>Optional. Enable tunnel path MTU discovery. If enabled
929 ``ICMP destination unreachable - fragmentation'' needed
930 messages will be generated for IPv4 packets with the DF bit set
931 and IPv6 packets above the minimum MTU if the packet size
932 exceeds the path MTU minus the size of the tunnel headers. It
933 also forces the encapsulating packet DF bit to be set (it is
934 always set if the inner packet implies path MTU discovery).
935 Note that this option causes behavior that is typically
936 reserved for routers and therefore is not entirely in
937 compliance with the IEEE 802.1D specification for bridges.
938 Default is enabled, set to <code>false</code> to disable.</dd>
941 <dt><code>capwap</code></dt>
942 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
943 (RFC 5415). This allows interoperability with certain switches
944 where GRE is not available. Note that only the tunneling component
945 of the protocol is implemented. Due to the non-standard use of
946 CAPWAP, UDP ports 58881 and 58882 are used as the source and
947 destination ports respectively. Each tunnel must be uniquely
948 identified by the combination of <code>remote_ip</code> and
949 <code>local_ip</code>. If two ports are defined that are the same
950 except one includes <code>local_ip</code> and the other does not,
951 the more specific one is matched first. CAPWAP support is not
952 available on all platforms. Currently it is only supported in the
953 Linux kernel module with kernel versions >= 2.6.25. The following
954 options may be specified in the <ref column="options"/> column:
956 <dt><code>remote_ip</code></dt>
957 <dd>Required. The tunnel endpoint.</dd>
960 <dt><code>local_ip</code></dt>
961 <dd>Optional. The destination IP that received packets must
962 match. Default is to match all addresses.</dd>
965 <dt><code>tos</code></dt>
966 <dd>Optional. The value of the ToS bits to be set on the
967 encapsulating packet. It may also be the word
968 <code>inherit</code>, in which case the ToS will be copied from
969 the inner packet if it is IPv4 or IPv6 (otherwise it will be
970 0). Note that the ECN fields are always inherited. Default is
974 <dt><code>ttl</code></dt>
975 <dd>Optional. The TTL to be set on the encapsulating packet.
976 It may also be the word <code>inherit</code>, in which case the
977 TTL will be copied from the inner packet if it is IPv4 or IPv6
978 (otherwise it will be the system default, typically 64).
979 Default is the system default TTL.</dd>
982 <dt><code>pmtud</code></dt>
983 <dd>Optional. Enable tunnel path MTU discovery. If enabled
984 ``ICMP destination unreachable - fragmentation'' needed
985 messages will be generated for IPv4 packets with the DF bit set
986 and IPv6 packets above the minimum MTU if the packet size
987 exceeds the path MTU minus the size of the tunnel headers. It
988 also forces the encapsulating packet DF bit to be set (it is
989 always set if the inner packet implies path MTU discovery).
990 Note that this option causes behavior that is typically
991 reserved for routers and therefore is not entirely in
992 compliance with the IEEE 802.1D specification for bridges.
993 Default is enabled, set to <code>false</code> to disable.</dd>
996 <dt><code>header_cache</code></dt>
997 <dd>Optional. Enable caching of tunnel headers and the output
998 path. This can lead to a significant performance increase
999 without changing behavior. In general it should not be
1000 necessary to adjust this setting. However, the caching can
1001 bypass certain components of the IP stack (such as IP tables)
1002 and it may be useful to disable it if these features are
1003 required or as a debugging measure. Default is enabled, set to
1004 <code>false</code> to disable.</dd>
1007 <dt><code>patch</code></dt>
1010 A pair of virtual devices that act as a patch cable. The <ref
1011 column="options"/> column must have the following key-value pair:
1014 <dt><code>peer</code></dt>
1016 The <ref column="name"/> of the <ref table="Interface"/> for
1017 the other side of the patch. The named <ref
1018 table="Interface"/>'s own <code>peer</code> option must specify
1019 this <ref table="Interface"/>'s name. That is, the two patch
1020 interfaces must have reversed <ref column="name"/> and
1021 <code>peer</code> values.
1028 <column name="options">
1029 Configuration options whose interpretation varies based on
1030 <ref column="type"/>.
1034 <group title="Interface Status">
1036 Status information about interfaces attached to bridges, updated every
1037 5 seconds. Not all interfaces have all of these properties; virtual
1038 interfaces don't have a link speed, for example. Non-applicable
1039 columns will have empty values.
1041 <column name="admin_state">
1043 The administrative state of the physical network link.
1047 <column name="link_state">
1049 The observed state of the physical network link;
1050 i.e. whether a carrier is detected by the interface.
1054 <column name="link_speed">
1056 The negotiated speed of the physical network link.
1057 Valid values are positive integers greater than 0.
1061 <column name="duplex">
1063 The duplex mode of the physical network link.
1069 The MTU (maximum transmission unit); i.e. the largest
1070 amount of data that can fit into a single Ethernet frame.
1071 The standard Ethernet MTU is 1500 bytes. Some physical media
1072 and many kinds of virtual interfaces can be configured with
1076 This column will be empty for an interface that does not
1077 have an MTU as, for example, some kinds of tunnels do not.
1081 <column name="status">
1083 Key-value pairs that report port status. Supported status
1084 values are <code>type</code>-dependent; some interfaces may not have
1085 a valid <code>driver_name</code>, for example.
1087 <p>The currently defined key-value pairs are:</p>
1089 <dt><code>driver_name</code></dt>
1090 <dd>The name of the device driver controlling the network
1094 <dt><code>driver_version</code></dt>
1095 <dd>The version string of the device driver controlling the
1096 network adapter.</dd>
1099 <dt><code>firmware_version</code></dt>
1100 <dd>The version string of the network adapter's firmware, if
1104 <dt><code>source_ip</code></dt>
1105 <dd>The source IP address used for an IPv4 tunnel end-point,
1106 such as <code>gre</code> or <code>capwap</code>.</dd>
1109 <dt><code>tunnel_egress_iface</code></dt>
1110 <dd>Egress interface for tunnels. Currently only relevant for GRE
1111 and CAPWAP tunnels. On Linux systems, this column will show
1112 the name of the interface which is responsible for routing
1113 traffic destined for the configured <code>remote_ip</code>.
1114 This could be an internal interface such as a bridge port.</dd>
1117 <dt><code>tunnel_egress_iface_carrier</code></dt>
1118 <dd>Whether a carrier is detected on <ref
1119 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1120 and <code>up</code>.</dd>
1125 <group title="Ingress Policing">
1127 These settings control ingress policing for packets received on this
1128 interface. On a physical interface, this limits the rate at which
1129 traffic is allowed into the system from the outside; on a virtual
1130 interface (one connected to a virtual machine), this limits the rate at
1131 which the VM is able to transmit.
1134 Policing is a simple form of quality-of-service that simply drops
1135 packets received in excess of the configured rate. Due to its
1136 simplicity, policing is usually less accurate and less effective than
1137 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1138 table="Queue"/> tables).
1141 Policing is currently implemented only on Linux. The Linux
1142 implementation uses a simple ``token bucket'' approach:
1146 The size of the bucket corresponds to <ref
1147 column="ingress_policing_burst"/>. Initially the bucket is full.
1150 Whenever a packet is received, its size (converted to tokens) is
1151 compared to the number of tokens currently in the bucket. If the
1152 required number of tokens are available, they are removed and the
1153 packet is forwarded. Otherwise, the packet is dropped.
1156 Whenever it is not full, the bucket is refilled with tokens at the
1157 rate specified by <ref column="ingress_policing_rate"/>.
1161 Policing interacts badly with some network protocols, and especially
1162 with fragmented IP packets. Suppose that there is enough network
1163 activity to keep the bucket nearly empty all the time. Then this token
1164 bucket algorithm will forward a single packet every so often, with the
1165 period depending on packet size and on the configured rate. All of the
1166 fragments of an IP packets are normally transmitted back-to-back, as a
1167 group. In such a situation, therefore, only one of these fragments
1168 will be forwarded and the rest will be dropped. IP does not provide
1169 any way for the intended recipient to ask for only the remaining
1170 fragments. In such a case there are two likely possibilities for what
1171 will happen next: either all of the fragments will eventually be
1172 retransmitted (as TCP will do), in which case the same problem will
1173 recur, or the sender will not realize that its packet has been dropped
1174 and data will simply be lost (as some UDP-based protocols will do).
1175 Either way, it is possible that no forward progress will ever occur.
1177 <column name="ingress_policing_rate">
1179 Maximum rate for data received on this interface, in kbps. Data
1180 received faster than this rate is dropped. Set to <code>0</code>
1181 (the default) to disable policing.
1185 <column name="ingress_policing_burst">
1186 <p>Maximum burst size for data received on this interface, in kb. The
1187 default burst size if set to <code>0</code> is 1000 kb. This value
1188 has no effect if <ref column="ingress_policing_rate"/>
1189 is <code>0</code>.</p>
1191 Specifying a larger burst size lets the algorithm be more forgiving,
1192 which is important for protocols like TCP that react severely to
1193 dropped packets. The burst size should be at least the size of the
1194 interface's MTU. Specifying a value that is numerically at least as
1195 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1196 closer to achieving the full rate.
1201 <group title="Other Features">
1203 <column name="monitor">
1204 Connectivity monitor configuration for this interface.
1207 <column name="external_ids">
1208 Key-value pairs for use by external frameworks that integrate
1209 with Open vSwitch, rather than by Open vSwitch itself. System
1210 integrators should either use the Open vSwitch development
1211 mailing list to coordinate on common key-value definitions, or
1212 choose key names that are likely to be unique. The currently
1213 defined common key-value pairs are:
1215 <dt><code>attached-mac</code></dt>
1217 The MAC address programmed into the ``virtual hardware'' for this
1218 interface, in the form
1219 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1220 For Citrix XenServer, this is the value of the <code>MAC</code>
1221 field in the VIF record for this interface.</dd>
1222 <dt><code>iface-id</code></dt>
1223 <dd>A system-unique identifier for the interface. On XenServer,
1224 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1227 Additionally the following key-value pairs specifically
1228 apply to an interface that represents a virtual Ethernet interface
1229 connected to a virtual machine. These key-value pairs should not be
1230 present for other types of interfaces. Keys whose names end
1231 in <code>-uuid</code> have values that uniquely identify the entity
1232 in question. For a Citrix XenServer hypervisor, these values are
1233 UUIDs in RFC 4122 format. Other hypervisors may use other
1236 <p>The currently defined key-value pairs for XenServer are:</p>
1238 <dt><code>xs-vif-uuid</code></dt>
1239 <dd>The virtual interface associated with this interface.</dd>
1240 <dt><code>xs-network-uuid</code></dt>
1241 <dd>The virtual network to which this interface is attached.</dd>
1242 <dt><code>xs-vm-uuid</code></dt>
1243 <dd>The VM to which this interface belongs.</dd>
1247 <column name="other_config">
1248 Key-value pairs for rarely used interface features.
1250 <dt><code>lacp-port-priority</code></dt>
1251 <dd> The LACP port priority of this <ref table="Interface"/>. In
1252 LACP negotiations <ref table="Interface"/>s with numerically lower
1253 priorities are preferred for aggregation. Must be a number between
1258 <column name="statistics">
1260 Key-value pairs that report interface statistics. The current
1261 implementation updates these counters periodically. In the future,
1262 we plan to, instead, update them when an interface is created, when
1263 they are queried (e.g. using an OVSDB <code>select</code> operation),
1264 and just before an interface is deleted due to virtual interface
1265 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1266 regular periodic basis.</p>
1268 The currently defined key-value pairs are listed below. These are
1269 the same statistics reported by OpenFlow in its <code>struct
1270 ofp_port_stats</code> structure. If an interface does not support a
1271 given statistic, then that pair is omitted.</p>
1274 Successful transmit and receive counters:
1276 <dt><code>rx_packets</code></dt>
1277 <dd>Number of received packets.</dd>
1278 <dt><code>rx_bytes</code></dt>
1279 <dd>Number of received bytes.</dd>
1280 <dt><code>tx_packets</code></dt>
1281 <dd>Number of transmitted packets.</dd>
1282 <dt><code>tx_bytes</code></dt>
1283 <dd>Number of transmitted bytes.</dd>
1289 <dt><code>rx_dropped</code></dt>
1290 <dd>Number of packets dropped by RX.</dd>
1291 <dt><code>rx_frame_err</code></dt>
1292 <dd>Number of frame alignment errors.</dd>
1293 <dt><code>rx_over_err</code></dt>
1294 <dd>Number of packets with RX overrun.</dd>
1295 <dt><code>rx_crc_err</code></dt>
1296 <dd>Number of CRC errors.</dd>
1297 <dt><code>rx_errors</code></dt>
1299 Total number of receive errors, greater than or equal
1300 to the sum of the above.
1307 <dt><code>tx_dropped</code></dt>
1308 <dd>Number of packets dropped by TX.</dd>
1309 <dt><code>collisions</code></dt>
1310 <dd>Number of collisions.</dd>
1311 <dt><code>tx_errors</code></dt>
1313 Total number of transmit errors, greater
1314 than or equal to the sum of the above.
1323 <table name="QoS" title="Quality of Service configuration">
1324 <p>Quality of Service (QoS) configuration for each Port that
1327 <column name="type">
1328 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1329 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1330 identifies the types that a switch actually supports. The currently
1331 defined types are listed below:</p>
1333 <dt><code>linux-htb</code></dt>
1335 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1336 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1337 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1338 for information on how this classifier works and how to configure it.
1342 <dt><code>linux-hfsc</code></dt>
1344 Linux "Hierarchical Fair Service Curve" classifier.
1345 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1346 information on how this classifier works.
1351 <column name="queues">
1352 <p>A map from queue numbers to <ref table="Queue"/> records. The
1353 supported range of queue numbers depend on <ref column="type"/>. The
1354 queue numbers are the same as the <code>queue_id</code> used in
1355 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1356 structures. Queue 0 is used by OpenFlow output actions that do not
1357 specify a specific queue.</p>
1360 <column name="other_config">
1361 <p>Key-value pairs for configuring QoS features that depend on
1362 <ref column="type"/>.</p>
1363 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1364 the following key-value pairs:</p>
1366 <dt><code>max-rate</code></dt>
1367 <dd>Maximum rate shared by all queued traffic, in bit/s.
1368 Optional. If not specified, for physical interfaces, the
1369 default is the link rate. For other interfaces or if the
1370 link rate cannot be determined, the default is currently 100
1375 <column name="external_ids">
1376 Key-value pairs for use by external frameworks that integrate with Open
1377 vSwitch, rather than by Open vSwitch itself. System integrators should
1378 either use the Open vSwitch development mailing list to coordinate on
1379 common key-value definitions, or choose key names that are likely to be
1380 unique. No common key-value pairs are currently defined.
1384 <table name="Queue" title="QoS output queue.">
1385 <p>A configuration for a port output queue, used in configuring Quality of
1386 Service (QoS) features. May be referenced by <ref column="queues"
1387 table="QoS"/> column in <ref table="QoS"/> table.</p>
1389 <column name="other_config">
1390 <p>Key-value pairs for configuring the output queue. The supported
1391 key-value pairs and their meanings depend on the <ref column="type"/>
1392 of the <ref column="QoS"/> records that reference this row.</p>
1393 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1394 column="type"/> of <code>min-rate</code> are:</p>
1396 <dt><code>min-rate</code></dt>
1397 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1398 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1400 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1401 column="type"/> of <code>linux-htb</code> are:</p>
1403 <dt><code>min-rate</code></dt>
1404 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1405 <dt><code>max-rate</code></dt>
1406 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1407 queue's rate will not be allowed to exceed the specified value, even
1408 if excess bandwidth is available. If unspecified, defaults to no
1410 <dt><code>burst</code></dt>
1411 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1412 that a queue can accumulate while it is idle. Optional. Details of
1413 the <code>linux-htb</code> implementation require a minimum burst
1414 size, so a too-small <code>burst</code> will be silently
1416 <dt><code>priority</code></dt>
1417 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1418 unspecified. A queue with a smaller <code>priority</code>
1419 will receive all the excess bandwidth that it can use before
1420 a queue with a larger value receives any. Specific priority
1421 values are unimportant; only relative ordering matters.</dd>
1423 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1424 column="type"/> of <code>linux-hfsc</code> are:</p>
1426 <dt><code>min-rate</code></dt>
1427 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1428 <dt><code>max-rate</code></dt>
1429 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1430 queue's rate will not be allowed to exceed the specified value, even
1431 if excess bandwidth is available. If unspecified, defaults to no
1436 <column name="external_ids">
1437 Key-value pairs for use by external frameworks that integrate with Open
1438 vSwitch, rather than by Open vSwitch itself. System integrators should
1439 either use the Open vSwitch development mailing list to coordinate on
1440 common key-value definitions, or choose key names that are likely to be
1441 unique. No common key-value pairs are currently defined.
1445 <table name="Monitor" title="Connectivity Monitor configuration">
1447 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1448 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1449 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1450 to detect connectivity problems with each other. MPs within a MA should
1451 have complete and exclusive interconnectivity. This is verified by
1452 occasionally broadcasting Continuity Check Messages (CCMs) at a
1453 configurable transmission interval. A <ref table="Monitor"/> is
1454 responsible for collecting data about other MPs in its MA and
1458 <group title="Monitor Configuration">
1459 <column name="mpid">
1460 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1461 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1462 used to identify this <ref table="Monitor"/> to other endpoints in the
1466 <column name="remote_mps">
1467 A set of <ref table="Maintenance_Points"/> which this
1468 <ref table="Monitor"/> should have connectivity to. If this
1469 <ref table="Monitor"/> does not have connectivity to any MPs in this
1470 set, or has connectivity to any MPs not in this set, a fault is
1474 <column name="ma_name">
1475 A Maintenance Association (MA) name pairs with a Maintenance Domain
1476 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1477 have complete and exclusive interconnectivity. Defaults to
1478 <code>ovs</code> if unset.
1481 <column name="md_name">
1482 A Maintenance Domain name pairs with a Maintenance Association name to
1483 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1486 <column name="interval">
1487 The transmission interval of CCMs in milliseconds. Three missed CCMs
1488 indicate a connectivity fault. Defaults to 1000ms.
1492 <group title="Monitor Status">
1493 <column name="unexpected_remote_mpids">
1494 A set of MPIDs representing MPs to which this <ref table="Monitor"/>
1495 has detected connectivity that are not in the
1496 <ref column="remote_mps"/> set. This <ref table="Monitor"/> should not
1497 have connectivity to any MPs not listed in <ref column="remote_mps"/>.
1498 Thus, if this set is non-empty a fault is indicated.
1501 <column name="unexpected_remote_maids">
1502 A set of MAIDs representing foreign Maintenance Associations (MAs)
1503 which this <ref table="Monitor"/> has detected connectivity to. A
1504 <ref table="Monitor"/> should not have connectivity to a Maintenance
1505 Association other than its own. Thus, if this set is non-empty a fault
1509 <column name="fault">
1510 Indicates a Connectivity Fault caused by a configuration error, a down
1511 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1516 <table name="Maintenance_Point" title="Maintenance Point configuration">
1518 A <ref table="Maintenance_Point"/> represents a MP which a
1519 <ref table="Monitor"/> has or should have connectivity to.
1522 <group title="Maintenance_Point Configuration">
1523 <column name="mpid">
1524 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1525 a Maintenance Association. All MPs within a MA should have a unique
1530 <group title="Maintenance_Point Status">
1531 <column name="fault">
1532 Indicates a connectivity fault.
1537 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1538 <p>A port mirror within a <ref table="Bridge"/>.</p>
1539 <p>A port mirror configures a bridge to send selected frames to special
1540 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1541 traffic may also be referred to as SPAN or RSPAN, depending on the
1542 mechanism used for delivery.</p>
1544 <column name="name">
1545 Arbitrary identifier for the <ref table="Mirror"/>.
1548 <group title="Selecting Packets for Mirroring">
1549 <column name="select_all">
1550 If true, every packet arriving or departing on any port is
1551 selected for mirroring.
1554 <column name="select_dst_port">
1555 Ports on which departing packets are selected for mirroring.
1558 <column name="select_src_port">
1559 Ports on which arriving packets are selected for mirroring.
1562 <column name="select_vlan">
1563 VLANs on which packets are selected for mirroring. An empty set
1564 selects packets on all VLANs.
1568 <group title="Mirroring Destination Configuration">
1569 <column name="output_port">
1570 <p>Output port for selected packets, if nonempty. Mutually exclusive
1571 with <ref column="output_vlan"/>.</p>
1572 <p>Specifying a port for mirror output reserves that port exclusively
1573 for mirroring. No frames other than those selected for mirroring
1574 will be forwarded to the port, and any frames received on the port
1575 will be discarded.</p>
1576 <p>This type of mirroring is sometimes called SPAN.</p>
1579 <column name="output_vlan">
1580 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
1581 with <ref column="output_port"/>.</p>
1582 <p>The frames will be sent out all ports that trunk
1583 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1584 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1585 trunk port, the frame's VLAN tag will be set to
1586 <ref column="output_vlan"/>, replacing any existing tag; when it is
1587 sent out an implicit VLAN port, the frame will not be tagged. This
1588 type of mirroring is sometimes called RSPAN.</p>
1589 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1590 contains unmanaged switches. Consider an unmanaged physical switch
1591 with two ports: port 1, connected to an end host, and port 2,
1592 connected to an Open vSwitch configured to mirror received packets
1593 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1594 port 1 that the physical switch forwards to port 2. The Open vSwitch
1595 forwards this packet to its destination and then reflects it back on
1596 port 2 in VLAN 123. This reflected packet causes the unmanaged
1597 physical switch to replace the MAC learning table entry, which
1598 correctly pointed to port 1, with one that incorrectly points to port
1599 2. Afterward, the physical switch will direct packets destined for
1600 the end host to the Open vSwitch on port 2, instead of to the end
1601 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1602 desired in this scenario, then the physical switch must be replaced
1603 by one that learns Ethernet addresses on a per-VLAN basis. In
1604 addition, learning should be disabled on the VLAN containing mirrored
1605 traffic. If this is not done then intermediate switches will learn
1606 the MAC address of each end host from the mirrored traffic. If
1607 packets being sent to that end host are also mirrored, then they will
1608 be dropped since the switch will attempt to send them out the input
1609 port. Disabling learning for the VLAN will cause the switch to
1610 correctly send the packet out all ports configured for that VLAN. If
1611 Open vSwitch is being used as an intermediate switch, learning can be
1612 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1613 in the appropriate <ref table="Bridge"/> table or tables.</p>
1617 <group title="Other Features">
1618 <column name="external_ids">
1619 Key-value pairs for use by external frameworks that integrate with Open
1620 vSwitch, rather than by Open vSwitch itself. System integrators should
1621 either use the Open vSwitch development mailing list to coordinate on
1622 common key-value definitions, or choose key names that are likely to be
1623 unique. No common key-value pairs are currently defined.
1628 <table name="Controller" title="OpenFlow controller configuration.">
1629 <p>An OpenFlow controller.</p>
1632 Open vSwitch supports two kinds of OpenFlow controllers:
1636 <dt>Primary controllers</dt>
1639 This is the kind of controller envisioned by the OpenFlow 1.0
1640 specification. Usually, a primary controller implements a network
1641 policy by taking charge of the switch's flow table.
1645 Open vSwitch initiates and maintains persistent connections to
1646 primary controllers, retrying the connection each time it fails or
1647 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1648 <ref table="Bridge"/> table applies to primary controllers.
1652 Open vSwitch permits a bridge to have any number of primary
1653 controllers. When multiple controllers are configured, Open
1654 vSwitch connects to all of them simultaneously. Because
1655 OpenFlow 1.0 does not specify how multiple controllers
1656 coordinate in interacting with a single switch, more than
1657 one primary controller should be specified only if the
1658 controllers are themselves designed to coordinate with each
1659 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1660 vendor extension may be useful for this.)
1663 <dt>Service controllers</dt>
1666 These kinds of OpenFlow controller connections are intended for
1667 occasional support and maintenance use, e.g. with
1668 <code>ovs-ofctl</code>. Usually a service controller connects only
1669 briefly to inspect or modify some of a switch's state.
1673 Open vSwitch listens for incoming connections from service
1674 controllers. The service controllers initiate and, if necessary,
1675 maintain the connections from their end. The <ref table="Bridge"
1676 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1677 not apply to service controllers.
1681 Open vSwitch supports configuring any number of service controllers.
1687 The <ref column="target"/> determines the type of controller.
1690 <group title="Core Features">
1691 <column name="target">
1692 <p>Connection method for controller.</p>
1694 The following connection methods are currently supported for primary
1698 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1700 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1701 the given <var>ip</var>, which must be expressed as an IP address
1702 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1703 column in the <ref table="Open_vSwitch"/> table must point to a
1704 valid SSL configuration when this form is used.</p>
1705 <p>SSL support is an optional feature that is not always built as
1706 part of Open vSwitch.</p>
1708 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1709 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1710 the given <var>ip</var>, which must be expressed as an IP address
1711 (not a DNS name).</dd>
1714 The following connection methods are currently supported for service
1718 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1721 Listens for SSL connections on the specified TCP <var>port</var>
1722 (default: 6633). If <var>ip</var>, which must be expressed as an
1723 IP address (not a DNS name), is specified, then connections are
1724 restricted to the specified local IP address.
1727 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1728 table="Open_vSwitch"/> table must point to a valid SSL
1729 configuration when this form is used.
1731 <p>SSL support is an optional feature that is not always built as
1732 part of Open vSwitch.</p>
1734 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1736 Listens for connections on the specified TCP <var>port</var>
1737 (default: 6633). If <var>ip</var>, which must be expressed as an
1738 IP address (not a DNS name), is specified, then connections are
1739 restricted to the specified local IP address.
1742 <p>When multiple controllers are configured for a single bridge, the
1743 <ref column="target"/> values must be unique. Duplicate
1744 <ref column="target"/> values yield unspecified results.</p>
1747 <column name="connection_mode">
1748 <p>If it is specified, this setting must be one of the following
1749 strings that describes how Open vSwitch contacts this OpenFlow
1750 controller over the network:</p>
1753 <dt><code>in-band</code></dt>
1754 <dd>In this mode, this controller's OpenFlow traffic travels over the
1755 bridge associated with the controller. With this setting, Open
1756 vSwitch allows traffic to and from the controller regardless of the
1757 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1758 would never be able to connect to the controller, because it did
1759 not have a flow to enable it.) This is the most common connection
1760 mode because it is not necessary to maintain two independent
1762 <dt><code>out-of-band</code></dt>
1763 <dd>In this mode, OpenFlow traffic uses a control network separate
1764 from the bridge associated with this controller, that is, the
1765 bridge does not use any of its own network devices to communicate
1766 with the controller. The control network must be configured
1767 separately, before or after <code>ovs-vswitchd</code> is started.
1771 <p>If not specified, the default is implementation-specific.</p>
1775 <group title="Controller Failure Detection and Handling">
1776 <column name="max_backoff">
1777 Maximum number of milliseconds to wait between connection attempts.
1778 Default is implementation-specific.
1781 <column name="inactivity_probe">
1782 Maximum number of milliseconds of idle time on connection to
1783 controller before sending an inactivity probe message. If Open
1784 vSwitch does not communicate with the controller for the specified
1785 number of seconds, it will send a probe. If a response is not
1786 received for the same additional amount of time, Open vSwitch
1787 assumes the connection has been broken and attempts to reconnect.
1788 Default is implementation-specific.
1792 <group title="OpenFlow Rate Limiting">
1793 <column name="controller_rate_limit">
1794 <p>The maximum rate at which packets in unknown flows will be
1795 forwarded to the OpenFlow controller, in packets per second. This
1796 feature prevents a single bridge from overwhelming the controller.
1797 If not specified, the default is implementation-specific.</p>
1798 <p>In addition, when a high rate triggers rate-limiting, Open
1799 vSwitch queues controller packets for each port and transmits
1800 them to the controller at the configured rate. The number of
1801 queued packets is limited by
1802 the <ref column="controller_burst_limit"/> value. The packet
1803 queue is shared fairly among the ports on a bridge.</p><p>Open
1804 vSwitch maintains two such packet rate-limiters per bridge.
1805 One of these applies to packets sent up to the controller
1806 because they do not correspond to any flow. The other applies
1807 to packets sent up to the controller by request through flow
1808 actions. When both rate-limiters are filled with packets, the
1809 actual rate that packets are sent to the controller is up to
1810 twice the specified rate.</p>
1813 <column name="controller_burst_limit">
1814 In conjunction with <ref column="controller_rate_limit"/>,
1815 the maximum number of unused packet credits that the bridge will
1816 allow to accumulate, in packets. If not specified, the default
1817 is implementation-specific.
1821 <group title="Additional In-Band Configuration">
1822 <p>These values are considered only in in-band control mode (see
1823 <ref column="connection_mode"/>).</p>
1825 <p>When multiple controllers are configured on a single bridge, there
1826 should be only one set of unique values in these columns. If different
1827 values are set for these columns in different controllers, the effect
1830 <column name="local_ip">
1831 The IP address to configure on the local port,
1832 e.g. <code>192.168.0.123</code>. If this value is unset, then
1833 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1837 <column name="local_netmask">
1838 The IP netmask to configure on the local port,
1839 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1840 but this value is unset, then the default is chosen based on whether
1841 the IP address is class A, B, or C.
1844 <column name="local_gateway">
1845 The IP address of the gateway to configure on the local port, as a
1846 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1847 this network has no gateway.
1851 <group title="Other Features">
1852 <column name="external_ids">
1853 Key-value pairs for use by external frameworks that integrate with Open
1854 vSwitch, rather than by Open vSwitch itself. System integrators should
1855 either use the Open vSwitch development mailing list to coordinate on
1856 common key-value definitions, or choose key names that are likely to be
1857 unique. No common key-value pairs are currently defined.
1861 <group title="Controller Status">
1862 <column name="is_connected">
1863 <code>true</code> if currently connected to this controller,
1864 <code>false</code> otherwise.
1867 <column name="role">
1868 <p>The level of authority this controller has on the associated
1869 bridge. Possible values are:</p>
1871 <dt><code>other</code></dt>
1872 <dd>Allows the controller access to all OpenFlow features.</dd>
1873 <dt><code>master</code></dt>
1874 <dd>Equivalent to <code>other</code>, except that there may be at
1875 most one master controller at a time. When a controller configures
1876 itself as <code>master</code>, any existing master is demoted to
1877 the <code>slave</code>role.</dd>
1878 <dt><code>slave</code></dt>
1879 <dd>Allows the controller read-only access to OpenFlow features.
1880 Attempts to modify the flow table will be rejected with an
1881 error. Slave controllers do not receive OFPT_PACKET_IN or
1882 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1887 <column name="status">
1888 <p>Key-value pairs that report controller status.</p>
1890 <dt><code>last_error</code></dt>
1891 <dd>A human-readable description of the last error on the connection
1892 to the controller; i.e. <code>strerror(errno)</code>. This key
1893 will exist only if an error has occurred.</dd>
1894 <dt><code>state</code></dt>
1895 <dd>The state of the connection to the controller. Possible values
1896 are: <code>VOID</code> (connection is disabled),
1897 <code>BACKOFF</code> (attempting to reconnect at an increasing
1898 period), <code>CONNECTING</code> (attempting to connect),
1899 <code>ACTIVE</code> (connected, remote host responsive), and
1900 <code>IDLE</code> (remote host idle, sending keep-alive). These
1901 values may change in the future. They are provided only for human
1903 <dt><code>sec_since_connect</code></dt>
1904 <dd>The amount of time since this controller last successfully
1905 connected to the switch (in seconds). Value is empty if controller
1906 has never successfully connected.</dd>
1907 <dt><code>sec_since_disconnect</code></dt>
1908 <dd>The amount of time since this controller last disconnected from
1909 the switch (in seconds). Value is empty if controller has never
1916 <table name="Manager" title="OVSDB management connection.">
1918 Configuration for a database connection to an Open vSwitch database
1923 This table primarily configures the Open vSwitch database
1924 (<code>ovsdb-server</code>), not the Open vSwitch switch
1925 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1926 what connections should be treated as in-band.
1930 The Open vSwitch database server can initiate and maintain active
1931 connections to remote clients. It can also listen for database
1935 <group title="Core Features">
1936 <column name="target">
1937 <p>Connection method for managers.</p>
1939 The following connection methods are currently supported:
1942 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1945 The specified SSL <var>port</var> (default: 6632) on the host at
1946 the given <var>ip</var>, which must be expressed as an IP address
1947 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1948 column in the <ref table="Open_vSwitch"/> table must point to a
1949 valid SSL configuration when this form is used.
1952 SSL support is an optional feature that is not always built as
1953 part of Open vSwitch.
1957 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1959 The specified TCP <var>port</var> (default: 6632) on the host at
1960 the given <var>ip</var>, which must be expressed as an IP address
1963 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1966 Listens for SSL connections on the specified TCP <var>port</var>
1967 (default: 6632). If <var>ip</var>, which must be expressed as an
1968 IP address (not a DNS name), is specified, then connections are
1969 restricted to the specified local IP address.
1972 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1973 table="Open_vSwitch"/> table must point to a valid SSL
1974 configuration when this form is used.
1977 SSL support is an optional feature that is not always built as
1978 part of Open vSwitch.
1981 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1983 Listens for connections on the specified TCP <var>port</var>
1984 (default: 6632). If <var>ip</var>, which must be expressed as an
1985 IP address (not a DNS name), is specified, then connections are
1986 restricted to the specified local IP address.
1989 <p>When multiple managers are configured, the <ref column="target"/>
1990 values must be unique. Duplicate <ref column="target"/> values yield
1991 unspecified results.</p>
1994 <column name="connection_mode">
1996 If it is specified, this setting must be one of the following strings
1997 that describes how Open vSwitch contacts this OVSDB client over the
2002 <dt><code>in-band</code></dt>
2004 In this mode, this connection's traffic travels over a bridge
2005 managed by Open vSwitch. With this setting, Open vSwitch allows
2006 traffic to and from the client regardless of the contents of the
2007 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2008 to connect to the client, because it did not have a flow to enable
2009 it.) This is the most common connection mode because it is not
2010 necessary to maintain two independent networks.
2012 <dt><code>out-of-band</code></dt>
2014 In this mode, the client's traffic uses a control network separate
2015 from that managed by Open vSwitch, that is, Open vSwitch does not
2016 use any of its own network devices to communicate with the client.
2017 The control network must be configured separately, before or after
2018 <code>ovs-vswitchd</code> is started.
2023 If not specified, the default is implementation-specific.
2028 <group title="Client Failure Detection and Handling">
2029 <column name="max_backoff">
2030 Maximum number of milliseconds to wait between connection attempts.
2031 Default is implementation-specific.
2034 <column name="inactivity_probe">
2035 Maximum number of milliseconds of idle time on connection to the client
2036 before sending an inactivity probe message. If Open vSwitch does not
2037 communicate with the client for the specified number of seconds, it
2038 will send a probe. If a response is not received for the same
2039 additional amount of time, Open vSwitch assumes the connection has been
2040 broken and attempts to reconnect. Default is implementation-specific.
2044 <group title="Other Features">
2045 <column name="external_ids">
2046 Key-value pairs for use by external frameworks that integrate with Open
2047 vSwitch, rather than by Open vSwitch itself. System integrators should
2048 either use the Open vSwitch development mailing list to coordinate on
2049 common key-value definitions, or choose key names that are likely to be
2050 unique. No common key-value pairs are currently defined.
2054 <group title="Status">
2055 <column name="is_connected">
2056 <code>true</code> if currently connected to this manager,
2057 <code>false</code> otherwise.
2060 <column name="status">
2061 <p>Key-value pairs that report manager status.</p>
2063 <dt><code>last_error</code></dt>
2064 <dd>A human-readable description of the last error on the connection
2065 to the manager; i.e. <code>strerror(errno)</code>. This key
2066 will exist only if an error has occurred.</dd>
2069 <dt><code>state</code></dt>
2070 <dd>The state of the connection to the manager. Possible values
2071 are: <code>VOID</code> (connection is disabled),
2072 <code>BACKOFF</code> (attempting to reconnect at an increasing
2073 period), <code>CONNECTING</code> (attempting to connect),
2074 <code>ACTIVE</code> (connected, remote host responsive), and
2075 <code>IDLE</code> (remote host idle, sending keep-alive). These
2076 values may change in the future. They are provided only for human
2080 <dt><code>sec_since_connect</code></dt>
2081 <dd>The amount of time since this manager last successfully connected
2082 to the database (in seconds). Value is empty if manager has never
2083 successfully connected.</dd>
2086 <dt><code>sec_since_disconnect</code></dt>
2087 <dd>The amount of time since this manager last disconnected from the
2088 database (in seconds). Value is empty if manager has never
2095 <table name="NetFlow">
2096 A NetFlow target. NetFlow is a protocol that exports a number of
2097 details about terminating IP flows, such as the principals involved
2100 <column name="targets">
2101 NetFlow targets in the form
2102 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2103 must be specified numerically, not as a DNS name.
2106 <column name="engine_id">
2107 Engine ID to use in NetFlow messages. Defaults to datapath index
2111 <column name="engine_type">
2112 Engine type to use in NetFlow messages. Defaults to datapath
2113 index if not specified.
2116 <column name="active_timeout">
2117 The interval at which NetFlow records are sent for flows that are
2118 still active, in seconds. A value of <code>0</code> requests the
2119 default timeout (currently 600 seconds); a value of <code>-1</code>
2120 disables active timeouts.
2123 <column name="add_id_to_interface">
2124 <p>If this column's value is <code>false</code>, the ingress and egress
2125 interface fields of NetFlow flow records are derived from OpenFlow port
2126 numbers. When it is <code>true</code>, the 7 most significant bits of
2127 these fields will be replaced by the least significant 7 bits of the
2128 engine id. This is useful because many NetFlow collectors do not
2129 expect multiple switches to be sending messages from the same host, so
2130 they do not store the engine information which could be used to
2131 disambiguate the traffic.</p>
2132 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2135 <column name="external_ids">
2136 Key-value pairs for use by external frameworks that integrate with Open
2137 vSwitch, rather than by Open vSwitch itself. System integrators should
2138 either use the Open vSwitch development mailing list to coordinate on
2139 common key-value definitions, or choose key names that are likely to be
2140 unique. No common key-value pairs are currently defined.
2145 SSL configuration for an Open_vSwitch.
2147 <column name="private_key">
2148 Name of a PEM file containing the private key used as the switch's
2149 identity for SSL connections to the controller.
2152 <column name="certificate">
2153 Name of a PEM file containing a certificate, signed by the
2154 certificate authority (CA) used by the controller and manager,
2155 that certifies the switch's private key, identifying a trustworthy
2159 <column name="ca_cert">
2160 Name of a PEM file containing the CA certificate used to verify
2161 that the switch is connected to a trustworthy controller.
2164 <column name="bootstrap_ca_cert">
2165 If set to <code>true</code>, then Open vSwitch will attempt to
2166 obtain the CA certificate from the controller on its first SSL
2167 connection and save it to the named PEM file. If it is successful,
2168 it will immediately drop the connection and reconnect, and from then
2169 on all SSL connections must be authenticated by a certificate signed
2170 by the CA certificate thus obtained. <em>This option exposes the
2171 SSL connection to a man-in-the-middle attack obtaining the initial
2172 CA certificate.</em> It may still be useful for bootstrapping.
2175 <column name="external_ids">
2176 Key-value pairs for use by external frameworks that integrate with Open
2177 vSwitch, rather than by Open vSwitch itself. System integrators should
2178 either use the Open vSwitch development mailing list to coordinate on
2179 common key-value definitions, or choose key names that are likely to be
2180 unique. No common key-value pairs are currently defined.
2184 <table name="sFlow">
2185 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2188 <column name="agent">
2189 Name of the network device whose IP address should be reported as the
2190 ``agent address'' to collectors. If not specified, the IP address
2191 defaults to the <ref table="Controller" column="local_ip"/> in the
2192 collector's <ref table="Controller"/>. If an agent IP address cannot be
2193 determined either way, sFlow is disabled.
2196 <column name="header">
2197 Number of bytes of a sampled packet to send to the collector.
2198 If not specified, the default is 128 bytes.
2201 <column name="polling">
2202 Polling rate in seconds to send port statistics to the collector.
2203 If not specified, defaults to 30 seconds.
2206 <column name="sampling">
2207 Rate at which packets should be sampled and sent to the collector.
2208 If not specified, defaults to 400, which means one out of 400
2209 packets, on average, will be sent to the collector.
2212 <column name="targets">
2213 sFlow targets in the form
2214 <code><var>ip</var>:<var>port</var></code>.
2217 <column name="external_ids">
2218 Key-value pairs for use by external frameworks that integrate with Open
2219 vSwitch, rather than by Open vSwitch itself. System integrators should
2220 either use the Open vSwitch development mailing list to coordinate on
2221 common key-value definitions, or choose key names that are likely to be
2222 unique. No common key-value pairs are currently defined.
2226 <table name="Capability">
2227 <p>Records in this table describe functionality supported by the hardware
2228 and software platform on which this Open vSwitch is based. Clients
2229 should not modify this table.</p>
2231 <p>A record in this table is meaningful only if it is referenced by the
2232 <ref table="Open_vSwitch" column="capabilities"/> column in the
2233 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2234 the record's ``category,'' determines the meanings of the
2235 <ref column="details"/> column. The following general forms of
2236 categories are currently defined:</p>
2239 <dt><code>qos-<var>type</var></code></dt>
2240 <dd><var>type</var> is supported as the value for
2241 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2245 <column name="details">
2246 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2247 depends on the category key that the <ref table="Open_vSwitch"
2248 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2249 uses to reference this record, as described above.</p>
2251 <p>The presence of a record for category <code>qos-<var>type</var></code>
2252 indicates that the switch supports <var>type</var> as the value of
2253 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2254 table. The following key-value pairs are defined to further describe
2255 QoS capabilities:</p>
2258 <dt><code>n-queues</code></dt>
2259 <dd>Number of supported queues, as a positive integer. Keys in the
2260 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2261 records whose <ref table="QoS" column="type"/> value
2262 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob