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="external_ids">
29 Key-value pairs for use by external frameworks that integrate
30 with Open vSwitch, rather than by Open vSwitch itself. System
31 integrators should either use the Open vSwitch development
32 mailing list to coordinate on common key-value definitions, or
33 choose key names that are likely to be unique. The currently
34 defined common key-value pairs are:
36 <dt><code>system-id</code></dt>
37 <dd>A unique identifier for the Open vSwitch's physical host.
38 The form of the identifier depends on the type of the host.
39 On a Citrix XenServer, this will likely be the same as
40 <code>xs-system-uuid</code>.</dd>
41 <dt><code>xs-system-uuid</code></dt>
42 <dd>The Citrix XenServer universally unique identifier for the
43 physical host as displayed by <code>xe host-list</code>.</dd>
48 <group title="Status">
49 <column name="next_cfg">
50 Sequence number for client to increment. When a client modifies
51 any part of the database configuration and wishes to wait for
52 Open vSwitch to finish applying the changes, it may increment
56 <column name="cur_cfg">
57 Sequence number that Open vSwitch sets to the current value of
58 <ref column="next_cfg"/> after it finishes applying a set of
59 configuration changes.
62 <column name="capabilities">
63 Describes functionality supported by the hardware and software platform
64 on which this Open vSwitch is based. Clients should not modify this
65 column. See the <ref table="Capability"/> description for defined
66 capability categories and the meaning of associated
67 <ref table="Capability"/> records.
70 <column name="statistics">
72 Key-value pairs that report statistics about a system running an Open
73 vSwitch. These are updated periodically (currently, every 5
74 seconds). Key-value pairs that cannot be determined or that do not
75 apply to a platform are omitted.
79 <dt><code>cpu</code></dt>
82 Number of CPU processors, threads, or cores currently online and
83 available to the operating system on which Open vSwitch is
84 running, as an integer. This may be less than the number
85 installed, if some are not online or if they are not available to
89 Open vSwitch userspace processes are not multithreaded, but the
90 Linux kernel-based datapath is.
94 <dt><code>load_average</code></dt>
97 A comma-separated list of three floating-point numbers,
98 representing the system load average over the last 1, 5, and 15
99 minutes, respectively.
103 <dt><code>memory</code></dt>
106 A comma-separated list of integers, each of which represents a
107 quantity of memory in kilobytes that describes the operating
108 system on which Open vSwitch is running. In respective order,
113 <li>Total amount of RAM allocated to the OS.</li>
114 <li>RAM allocated to the OS that is in use.</li>
115 <li>RAM that can be flushed out to disk or otherwise discarded
116 if that space is needed for another purpose. This number is
117 necessarily less than or equal to the previous value.</li>
118 <li>Total disk space allocated for swap.</li>
119 <li>Swap space currently in use.</li>
123 On Linux, all five values can be determined and are included. On
124 other operating systems, only the first two values can be
125 determined, so the list will only have two values.
129 <dt><code>process_</code><var>name</var></dt>
132 One such key-value pair will exist for each running Open vSwitch
133 daemon process, with <var>name</var> replaced by the daemon's
134 name (e.g. <code>process_ovs-vswitchd</code>). The value is a
135 comma-separated list of integers. The integers represent the
136 following, with memory measured in kilobytes and durations in
141 <li>The process's virtual memory size.</li>
142 <li>The process's resident set size.</li>
143 <li>The amount of user and system CPU time consumed by the
145 <li>The number of times that the process has crashed and been
146 automatically restarted by the monitor.</li>
147 <li>The duration since the process was started.</li>
148 <li>The duration for which the process has been running.</li>
152 The interpretation of some of these values depends on whether the
153 process was started with the <option>--monitor</option>. If it
154 was not, then the crash count will always be 0 and the two
155 durations will always be the same. If <option>--monitor</option>
156 was given, then the crash count may be positive; if it is, the
157 latter duration is the amount of time since the most recent crash
162 There will be one key-value pair for each file in Open vSwitch's
163 ``run directory'' (usually <code>/var/run/openvswitch</code>)
164 whose name ends in <code>.pid</code>, whose contents are a
165 process ID, and which is locked by a running process. The
166 <var>name</var> is taken from the pidfile's name.
170 Currently Open vSwitch is only able to obtain all of the above
171 detail on Linux systems. On other systems, the same key-value
172 pairs will be present but the values will always be the empty
177 <dt><code>file_systems</code></dt>
180 A space-separated list of information on local, writable file
181 systems. Each item in the list describes one file system and
182 consists in turn of a comma-separated list of the following:
186 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
187 Any spaces or commas in the mount point are replaced by
189 <li>Total size, in kilobytes, as an integer.</li>
190 <li>Amount of storage in use, in kilobytes, as an integer.</li>
194 This key-value pair is omitted if there are no local, writable
195 file systems or if Open vSwitch cannot obtain the needed
203 <group title="Version Reporting">
205 These columns report the types and versions of the hardware and
206 software running Open vSwitch. We recommend in general that software
207 should test whether specific features are supported instead of relying
208 on version number checks. These values are primarily intended for
209 reporting to human administrators.
212 <column name="ovs_version">
213 The Open vSwitch version number, e.g. <code>1.1.0</code>.
214 If Open vSwitch was configured with a build number, then it is
215 also included, e.g. <code>1.1.0+build6579</code>.
218 <column name="db_version">
220 The database schema version number in the form
221 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
222 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
223 a non-backward compatible way (e.g. deleting a column or a table),
224 <var>major</var> is incremented. When the database schema is changed
225 in a backward compatible way (e.g. adding a new column),
226 <var>minor</var> is incremented. When the database schema is changed
227 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
232 The schema version is part of the database schema, so it can also be
233 retrieved by fetching the schema using the Open vSwitch database
238 <column name="system_type">
240 An identifier for the type of system on top of which Open vSwitch
241 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
244 System integrators are responsible for choosing and setting an
245 appropriate value for this column.
249 <column name="system_version">
251 The version of the system identified by <ref column="system_type"/>,
252 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
255 System integrators are responsible for choosing and setting an
256 appropriate value for this column.
262 <group title="Database Configuration">
264 These columns primarily configure the Open vSwitch database
265 (<code>ovsdb-server</code>), not the Open vSwitch switch
266 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
267 column="ssl"/> settings.
271 The Open vSwitch switch does read the database configuration to
272 determine remote IP addresses to which in-band control should apply.
275 <column name="manager_options">
276 Database clients to which the Open vSwitch database server should
277 connect or to which it should listen, along with options for how these
278 connection should be configured. See the <ref table="Manager"/> table
279 for more information.
284 <table name="Bridge">
286 Configuration for a bridge within an
287 <ref table="Open_vSwitch"/>.
290 A <ref table="Bridge"/> record represents an Ethernet switch with one or
291 more ``ports,'' which are the <ref table="Port"/> records pointed to by
292 the <ref table="Bridge"/>'s <ref column="ports"/> column.
295 <group title="Core Features">
297 Bridge identifier. Should be alphanumeric and no more than about 8
298 bytes long. Must be unique among the names of ports, interfaces, and
302 <column name="ports">
303 Ports included in the bridge.
306 <column name="mirrors">
307 Port mirroring configuration.
310 <column name="netflow">
311 NetFlow configuration.
314 <column name="sflow">
318 <column name="flood_vlans">
319 VLAN IDs of VLANs on which MAC address learning should be disabled, so
320 that packets are flooded instead of being sent to specific ports that
321 are believed to contain packets' destination MACs. This should
322 ordinarily be used to disable MAC learning on VLANs used for mirroring
323 (RSPAN VLANs). It may also be useful for debugging.
327 <group title="OpenFlow Configuration">
328 <column name="controller">
329 OpenFlow controller set. If unset, then no OpenFlow controllers
333 <column name="fail_mode">
334 <p>When a controller is configured, it is, ordinarily, responsible
335 for setting up all flows on the switch. Thus, if the connection to
336 the controller fails, no new network connections can be set up.
337 If the connection to the controller stays down long enough,
338 no packets can pass through the switch at all. This setting
339 determines the switch's response to such a situation. It may be set
340 to one of the following:
342 <dt><code>standalone</code></dt>
343 <dd>If no message is received from the controller for three
344 times the inactivity probe interval
345 (see <ref column="inactivity_probe"/>), then Open vSwitch
346 will take over responsibility for setting up flows. In
347 this mode, Open vSwitch causes the bridge to act like an
348 ordinary MAC-learning switch. Open vSwitch will continue
349 to retry connecting to the controller in the background
350 and, when the connection succeeds, it will discontinue its
351 standalone behavior.</dd>
352 <dt><code>secure</code></dt>
353 <dd>Open vSwitch will not set up flows on its own when the
354 controller connection fails or when no controllers are
355 defined. The bridge will continue to retry connecting to
356 any defined controllers forever.</dd>
359 <p>If this value is unset, the default is implementation-specific.</p>
360 <p>When more than one controller is configured,
361 <ref column="fail_mode"/> is considered only when none of the
362 configured controllers can be contacted.</p>
365 <column name="datapath_id">
366 Reports the OpenFlow datapath ID in use. Exactly 16 hex
367 digits. (Setting this column will have no useful effect. Set
368 <ref column="other_config"/>:<code>other-config</code>
373 <group title="Other Features">
374 <column name="datapath_type">
375 Name of datapath provider. The kernel datapath has
376 type <code>system</code>. The userspace datapath has
377 type <code>netdev</code>.
380 <column name="external_ids">
381 Key-value pairs for use by external frameworks that integrate
382 with Open vSwitch, rather than by Open vSwitch itself. System
383 integrators should either use the Open vSwitch development
384 mailing list to coordinate on common key-value definitions, or
385 choose key names that are likely to be unique. The currently
386 defined key-value pairs are:
388 <dt><code>bridge-id</code></dt>
389 <dd>A unique identifier of the bridge. On Citrix XenServer this
390 will commonly be the same as <code>xs-network-uuids</code>.</dd>
391 <dt><code>xs-network-uuids</code></dt>
392 <dd>Semicolon-delimited set of universally unique identifier(s) for
393 the network with which this bridge is associated on a Citrix
394 XenServer host. The network identifiers are RFC 4122 UUIDs as
395 displayed by, e.g., <code>xe network-list</code>.</dd>
399 <column name="other_config">
400 Key-value pairs for configuring rarely used bridge
401 features. The currently defined key-value pairs are:
403 <dt><code>datapath-id</code></dt>
405 digits to set the OpenFlow datapath ID to a specific
406 value. May not be all-zero.</dd>
407 <dt><code>disable-in-band</code></dt>
408 <dd>If set to <code>true</code>, disable in-band control on
409 the bridge regardless of controller and manager settings.</dd>
410 <dt><code>hwaddr</code></dt>
411 <dd>An Ethernet address in the form
412 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
413 to set the hardware address of the local port and influence the
415 <dt><code>in-band-queue</code></dt>
417 A queue ID as a nonnegative integer. This sets the OpenFlow queue
418 ID that will be used by flows set up by in-band control on this
419 bridge. If unset, or if the port used by an in-band control flow
420 does not have QoS configured, or if the port does not have a queue
421 with the specified ID, the default queue is used instead.
428 <table name="Port" table="Port or bond configuration.">
429 <p>A port within a <ref table="Bridge"/>.</p>
430 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
431 <ref column="interfaces"/> column. Such a port logically
432 corresponds to a port on a physical Ethernet switch. A port
433 with more than one interface is a ``bonded port'' (see
434 <ref group="Bonding Configuration"/>).</p>
435 <p>Some properties that one might think as belonging to a port are actually
436 part of the port's <ref table="Interface"/> members.</p>
439 Port name. Should be alphanumeric and no more than about 8
440 bytes long. May be the same as the interface name, for
441 non-bonded ports. Must otherwise be unique among the names of
442 ports, interfaces, and bridges on a host.
445 <column name="interfaces">
446 The port's interfaces. If there is more than one, this is a
450 <group title="VLAN Configuration">
451 <p>A bridge port must be configured for VLANs in one of two
452 mutually exclusive ways:
454 <li>A ``trunk port'' has an empty value for <ref
455 column="tag"/>. Its <ref column="trunks"/> value may be
456 empty or non-empty.</li>
457 <li>An ``implicitly tagged VLAN port'' or ``access port''
458 has an nonempty value for <ref column="tag"/>. Its
459 <ref column="trunks"/> value must be empty.</li>
461 If <ref column="trunks"/> and <ref column="tag"/> are both
462 nonempty, the configuration is ill-formed.
467 If this is an access port (see above), the port's implicitly
468 tagged VLAN. Must be empty if this is a trunk port.
471 Frames arriving on trunk ports will be forwarded to this
472 port only if they are tagged with the given VLAN (or, if
473 <ref column="tag"/> is 0, then if they lack a VLAN header).
474 Frames arriving on other access ports will be forwarded to
475 this port only if they have the same <ref column="tag"/>
476 value. Frames forwarded to this port will not have an
480 When a frame with a 802.1Q header that indicates a nonzero
481 VLAN is received on an access port, it is discarded.
485 <column name="trunks">
487 If this is a trunk port (see above), the 802.1Q VLAN(s) that
488 this port trunks; if it is empty, then the port trunks all
489 VLANs. Must be empty if this is an access port.
492 Frames arriving on trunk ports are dropped if they are not
493 in one of the specified VLANs. For this purpose, packets
494 that have no VLAN header are treated as part of VLAN 0.
499 <group title="Bonding Configuration">
500 <p>A port that has more than one interface is a ``bonded port.'' Bonding
501 allows for load balancing and fail-over. Some kinds of bonding will
502 work with any kind of upstream switch:</p>
505 <dt><code>balance-slb</code></dt>
507 Balances flows among slaves based on source MAC address and output
508 VLAN, with periodic rebalancing as traffic patterns change.
511 <dt><code>active-backup</code></dt>
513 Assigns all flows to one slave, failing over to a backup slave when
514 the active slave is disabled.
519 The following modes require the upstream switch to support 802.3ad with
520 successful LACP negotiation. If LACP negotiation fails then
521 <code>balance-slb</code> style flow hashing is used as a fallback:
525 <dt><code>balance-tcp</code></dt>
527 Balances flows among slaves based on L2, L3, and L4 protocol
528 information such as destination MAC address, IP address, and TCP
534 <dt><code>stable</code></dt>
536 <p>Attempts to always assign a given flow to the same slave
537 consistently. In an effort to maintain stability, no load
538 balancing is done. Uses a similar hashing strategy to
539 <code>balance-tcp</code>, falling back to <code>balance-slb</code>
540 style hashing when LACP negotiations are unsuccessful.</p>
541 <p>Slave selection decisions are made based on LACP port ID when LACP
542 negotiations are successful, falling back to openflow port number
543 when unsuccessful. Thus, decisions are consistent across all
544 ovs-vswitchd instances with equivalent port IDs.</p>
548 <p>These columns apply only to bonded ports. Their values are
549 otherwise ignored.</p>
551 <column name="bond_mode">
552 <p>The type of bonding used for a bonded port. Defaults to
553 <code>balance-slb</code> if unset.
557 <column name="bond_updelay">
558 <p>For a bonded port, the number of milliseconds for which carrier must
559 stay up on an interface before the interface is considered to be up.
560 Specify <code>0</code> to enable the interface immediately.</p>
561 <p>This setting is honored only when at least one bonded interface is
562 already enabled. When no interfaces are enabled, then the first bond
563 interface to come up is enabled immediately.</p>
566 <column name="bond_downdelay">
567 For a bonded port, the number of milliseconds for which carrier must
568 stay down on an interface before the interface is considered to be
569 down. Specify <code>0</code> to disable the interface immediately.
572 <column name="bond_fake_iface">
573 For a bonded port, whether to create a fake internal interface with the
574 name of the port. Use only for compatibility with legacy software that
579 <p>Configures LACP on this port. LACP allows directly connected
580 switches to negotiate which links may be bonded. LACP may be enabled
581 on non-bonded ports for the benefit of any switches they may be
582 connected to. <code>active</code> ports are allowed to initiate LACP
583 negotiations. <code>passive</code> ports are allowed to participate
584 in LACP negotiations initiated by a remote switch, but not allowed to
585 initiate such negotiations themselves. If unset Open vSwitch will
586 choose a reasonable default. </p>
591 <group title="Other Features">
593 Quality of Service configuration for this port.
597 The MAC address to use for this port for the purpose of choosing the
598 bridge's MAC address. This column does not necessarily reflect the
599 port's actual MAC address, nor will setting it change the port's actual
603 <column name="fake_bridge">
604 Does this port represent a sub-bridge for its tagged VLAN within the
605 Bridge? See ovs-vsctl(8) for more information.
608 <column name="external_ids">
610 Key-value pairs for use by external frameworks that integrate with
611 Open vSwitch, rather than by Open vSwitch itself. System integrators
612 should either use the Open vSwitch development mailing list to
613 coordinate on common key-value definitions, or choose key names that
614 are likely to be unique.
617 No key-value pairs native to <ref table="Port"/> are currently
618 defined. For fake bridges (see the <ref column="fake_bridge"/>
619 column), external IDs for the fake bridge are defined here by
620 prefixing a <ref table="Bridge"/> <ref table="Bridge"
621 column="external_ids"/> key with <code>fake-bridge-</code>,
622 e.g. <code>fake-bridge-xs-network-uuids</code>.
626 <column name="other_config">
627 Key-value pairs for configuring rarely used port features. The
628 currently defined key-value pairs are:
630 <dt><code>hwaddr</code></dt>
631 <dd>An Ethernet address in the form
632 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
633 <dt><code>bond-rebalance-interval</code></dt>
634 <dd>For an SLB bonded port, the number of milliseconds between
635 successive attempts to rebalance the bond, that is, to
636 move source MACs and their flows from one interface on
637 the bond to another in an attempt to keep usage of each
638 interface roughly equal. The default is 10000 (10
639 seconds), and the minimum is 1000 (1 second).</dd>
640 <dt><code>bond-detect-mode</code></dt>
641 <dd> Sets the method used to detect link failures in a bonded port.
642 Options are <code>carrier</code> and <code>miimon</code>. Defaults
643 to <code>carrier</code> which uses each interface's carrier to detect
644 failures. When set to <code>miimon</code>, will check for failures
645 by polling each interface's MII. </dd>
646 <dt><code>bond-miimon-interval</code></dt>
647 <dd> The number of milliseconds between successive attempts to
648 poll each interface's MII. Only relevant on ports which use
649 <code>miimon</code> to detect failures. </dd>
650 <dt><code>lacp-system-priority</code></dt>
651 <dd> The LACP system priority of this <ref table="Port"/>. In
652 LACP negotiations, link status decisions are made by the system
653 with the numerically lower priority. Must be a number between 1
655 <dt><code>lacp-time</code></dt>
656 <dd> The LACP timing which should be used on this
657 <ref table="Port"/>. Possible values are <code>fast</code> and
658 <code>slow</code>. By default <code>slow</code> is used. When
659 configured to be <code>fast</code> more frequent LACP heartbeats
660 will be requested causing connectivity problems to be detected more
667 <table name="Interface" title="One physical network device in a Port.">
668 An interface within a <ref table="Port"/>.
670 <group title="Core Features">
672 Interface name. Should be alphanumeric and no more than about 8 bytes
673 long. May be the same as the port name, for non-bonded ports. Must
674 otherwise be unique among the names of ports, interfaces, and bridges
679 <p>Ethernet address to set for this interface. If unset then the
680 default MAC address is used:</p>
682 <li>For the local interface, the default is the lowest-numbered MAC
683 address among the other bridge ports, either the value of the
684 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
685 if set, or its actual MAC (for bonded ports, the MAC of its slave
686 whose name is first in alphabetical order). Internal ports and
687 bridge ports that are used as port mirroring destinations (see the
688 <ref table="Mirror"/> table) are ignored.</li>
689 <li>For other internal interfaces, the default MAC is randomly
691 <li>External interfaces typically have a MAC address associated with
694 <p>Some interfaces may not have a software-controllable MAC
698 <column name="ofport">
699 <p>OpenFlow port number for this interface. Unlike most columns, this
700 column's value should be set only by Open vSwitch itself. Other
701 clients should set this column to an empty set (the default) when
702 creating an <ref table="Interface"/>.</p>
703 <p>Open vSwitch populates this column when the port number becomes
704 known. If the interface is successfully added,
705 <ref column="ofport"/> will be set to a number between 1 and 65535
706 (generally either in the range 1 to 65279, inclusive, or 65534, the
707 port number for the OpenFlow ``local port''). If the interface
708 cannot be added then Open vSwitch sets this column
713 <group title="System-Specific Details">
715 The interface type, one of:
717 <dt><code>system</code></dt>
718 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
719 Sometimes referred to as ``external interfaces'' since they are
720 generally connected to hardware external to that on which the Open
721 vSwitch is running. The empty string is a synonym for
722 <code>system</code>.</dd>
723 <dt><code>internal</code></dt>
724 <dd>A simulated network device that sends and receives traffic. An
725 internal interface whose <ref column="name"/> is the same as its
726 bridge's <ref table="Open_vSwitch" column="name"/> is called the
727 ``local interface.'' It does not make sense to bond an internal
728 interface, so the terms ``port'' and ``interface'' are often used
729 imprecisely for internal interfaces.</dd>
730 <dt><code>tap</code></dt>
731 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
732 <dt><code>gre</code></dt>
733 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
734 tunnel. Each tunnel must be uniquely identified by the
735 combination of <code>remote_ip</code>, <code>local_ip</code>, and
736 <code>in_key</code>. Note that if two ports are defined that are
737 the same except one has an optional identifier and the other does
738 not, the more specific one is matched first. <code>in_key</code>
739 is considered more specific than <code>local_ip</code> if a port
740 defines one and another port defines the other. The following
741 options may be specified in the <ref column="options"/> column:
743 <dt><code>remote_ip</code></dt>
744 <dd>Required. The tunnel endpoint.</dd>
747 <dt><code>local_ip</code></dt>
748 <dd>Optional. The destination IP that received packets must
749 match. Default is to match all addresses.</dd>
752 <dt><code>in_key</code></dt>
753 <dd>Optional. The GRE key that received packets must contain.
754 It may either be a 32-bit number (no key and a key of 0 are
755 treated as equivalent) or the word <code>flow</code>. If
756 <code>flow</code> is specified then any key will be accepted
757 and the key will be placed in the <code>tun_id</code> field
758 for matching in the flow table. The ovs-ofctl manual page
759 contains additional information about matching fields in
760 OpenFlow flows. Default is no key.</dd>
763 <dt><code>out_key</code></dt>
764 <dd>Optional. The GRE key to be set on outgoing packets. It may
765 either be a 32-bit number or the word <code>flow</code>. If
766 <code>flow</code> is specified then the key may be set using
767 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
768 is used in the absence of an action). The ovs-ofctl manual
769 page contains additional information about the Nicira OpenFlow
770 vendor extensions. Default is no key.</dd>
773 <dt><code>key</code></dt>
774 <dd>Optional. Shorthand to set <code>in_key</code> and
775 <code>out_key</code> at the same time.</dd>
778 <dt><code>tos</code></dt>
779 <dd>Optional. The value of the ToS bits to be set on the
780 encapsulating packet. It may also be the word
781 <code>inherit</code>, in which case the ToS will be copied from
782 the inner packet if it is IPv4 or IPv6 (otherwise it will be
783 0). Note that the ECN fields are always inherited. Default is
787 <dt><code>ttl</code></dt>
788 <dd>Optional. The TTL to be set on the encapsulating packet.
789 It may also be the word <code>inherit</code>, in which case the
790 TTL will be copied from the inner packet if it is IPv4 or IPv6
791 (otherwise it will be the system default, typically 64).
792 Default is the system default TTL.</dd>
795 <dt><code>csum</code></dt>
796 <dd>Optional. Compute GRE checksums on outgoing packets.
797 Checksums present on incoming packets will be validated
798 regardless of this setting. Note that GRE checksums
799 impose a significant performance penalty as they cover the
800 entire packet. As the contents of the packet is typically
801 covered by L3 and L4 checksums, this additional checksum only
802 adds value for the GRE and encapsulated Ethernet headers.
803 Default is disabled, set to <code>true</code> to enable.</dd>
806 <dt><code>pmtud</code></dt>
807 <dd>Optional. Enable tunnel path MTU discovery. If enabled
808 ``ICMP destination unreachable - fragmentation'' needed
809 messages will be generated for IPv4 packets with the DF bit set
810 and IPv6 packets above the minimum MTU if the packet size
811 exceeds the path MTU minus the size of the tunnel headers. It
812 also forces the encapsulating packet DF bit to be set (it is
813 always set if the inner packet implies path MTU discovery).
814 Note that this option causes behavior that is typically
815 reserved for routers and therefore is not entirely in
816 compliance with the IEEE 802.1D specification for bridges.
817 Default is enabled, set to <code>false</code> to disable.</dd>
820 <dt><code>header_cache</code></dt>
821 <dd>Optional. Enable caching of tunnel headers and the output
822 path. This can lead to a significant performance increase
823 without changing behavior. In general it should not be
824 necessary to adjust this setting. However, the caching can
825 bypass certain components of the IP stack (such as IP tables)
826 and it may be useful to disable it if these features are
827 required or as a debugging measure. Default is enabled, set to
828 <code>false</code> to disable.</dd>
831 <dt><code>ipsec_gre</code></dt>
832 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
833 over IPv4 IPsec tunnel. Each tunnel (including those of type
834 <code>gre</code>) must be uniquely identified by the
835 combination of <code>remote_ip</code> and
836 <code>local_ip</code>. Note that if two ports are defined
837 that are the same except one has an optional identifier and
838 the other does not, the more specific one is matched first.
839 An authentication method of <code>peer_cert</code> or
840 <code>psk</code> must be defined. The following options may
841 be specified in the <ref column="options"/> column:
843 <dt><code>remote_ip</code></dt>
844 <dd>Required. The tunnel endpoint.</dd>
847 <dt><code>local_ip</code></dt>
848 <dd>Optional. The destination IP that received packets must
849 match. Default is to match all addresses.</dd>
852 <dt><code>peer_cert</code></dt>
853 <dd>Required for certificate authentication. A string
854 containing the peer's certificate in PEM format.
855 Additionally the host's certificate must be specified
856 with the <code>certificate</code> option.</dd>
859 <dt><code>certificate</code></dt>
860 <dd>Required for certificate authentication. The name of a
861 PEM file containing a certificate that will be presented
862 to the peer during authentication.</dd>
865 <dt><code>private_key</code></dt>
866 <dd>Optional for certificate authentication. The name of
867 a PEM file containing the private key associated with
868 <code>certificate</code>. If <code>certificate</code>
869 contains the private key, this option may be omitted.</dd>
872 <dt><code>psk</code></dt>
873 <dd>Required for pre-shared key authentication. Specifies a
874 pre-shared key for authentication that must be identical on
875 both sides of the tunnel.</dd>
878 <dt><code>in_key</code></dt>
879 <dd>Optional. The GRE key that received packets must contain.
880 It may either be a 32-bit number (no key and a key of 0 are
881 treated as equivalent) or the word <code>flow</code>. If
882 <code>flow</code> is specified then any key will be accepted
883 and the key will be placed in the <code>tun_id</code> field
884 for matching in the flow table. The ovs-ofctl manual page
885 contains additional information about matching fields in
886 OpenFlow flows. Default is no key.</dd>
889 <dt><code>out_key</code></dt>
890 <dd>Optional. The GRE key to be set on outgoing packets. It may
891 either be a 32-bit number or the word <code>flow</code>. If
892 <code>flow</code> is specified then the key may be set using
893 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
894 is used in the absence of an action). The ovs-ofctl manual
895 page contains additional information about the Nicira OpenFlow
896 vendor extensions. Default is no key.</dd>
899 <dt><code>key</code></dt>
900 <dd>Optional. Shorthand to set <code>in_key</code> and
901 <code>out_key</code> at the same time.</dd>
904 <dt><code>tos</code></dt>
905 <dd>Optional. The value of the ToS bits to be set on the
906 encapsulating packet. It may also be the word
907 <code>inherit</code>, in which case the ToS will be copied from
908 the inner packet if it is IPv4 or IPv6 (otherwise it will be
909 0). Note that the ECN fields are always inherited. Default is
913 <dt><code>ttl</code></dt>
914 <dd>Optional. The TTL to be set on the encapsulating packet.
915 It may also be the word <code>inherit</code>, in which case the
916 TTL will be copied from the inner packet if it is IPv4 or IPv6
917 (otherwise it will be the system default, typically 64).
918 Default is the system default TTL.</dd>
921 <dt><code>csum</code></dt>
922 <dd>Optional. Compute GRE checksums on outgoing packets.
923 Checksums present on incoming packets will be validated
924 regardless of this setting. Note that GRE checksums
925 impose a significant performance penalty as they cover the
926 entire packet. As the contents of the packet is typically
927 covered by L3 and L4 checksums, this additional checksum only
928 adds value for the GRE and encapsulated Ethernet headers.
929 Default is disabled, set to <code>true</code> to enable.</dd>
932 <dt><code>pmtud</code></dt>
933 <dd>Optional. Enable tunnel path MTU discovery. If enabled
934 ``ICMP destination unreachable - fragmentation'' needed
935 messages will be generated for IPv4 packets with the DF bit set
936 and IPv6 packets above the minimum MTU if the packet size
937 exceeds the path MTU minus the size of the tunnel headers. It
938 also forces the encapsulating packet DF bit to be set (it is
939 always set if the inner packet implies path MTU discovery).
940 Note that this option causes behavior that is typically
941 reserved for routers and therefore is not entirely in
942 compliance with the IEEE 802.1D specification for bridges.
943 Default is enabled, set to <code>false</code> to disable.</dd>
946 <dt><code>capwap</code></dt>
947 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
948 (RFC 5415). This allows interoperability with certain switches
949 where GRE is not available. Note that only the tunneling component
950 of the protocol is implemented. Due to the non-standard use of
951 CAPWAP, UDP ports 58881 and 58882 are used as the source and
952 destination ports respectively. Each tunnel must be uniquely
953 identified by the combination of <code>remote_ip</code> and
954 <code>local_ip</code>. If two ports are defined that are the same
955 except one includes <code>local_ip</code> and the other does not,
956 the more specific one is matched first. CAPWAP support is not
957 available on all platforms. Currently it is only supported in the
958 Linux kernel module with kernel versions >= 2.6.25. The following
959 options may be specified in the <ref column="options"/> column:
961 <dt><code>remote_ip</code></dt>
962 <dd>Required. The tunnel endpoint.</dd>
965 <dt><code>local_ip</code></dt>
966 <dd>Optional. The destination IP that received packets must
967 match. Default is to match all addresses.</dd>
970 <dt><code>tos</code></dt>
971 <dd>Optional. The value of the ToS bits to be set on the
972 encapsulating packet. It may also be the word
973 <code>inherit</code>, in which case the ToS will be copied from
974 the inner packet if it is IPv4 or IPv6 (otherwise it will be
975 0). Note that the ECN fields are always inherited. Default is
979 <dt><code>ttl</code></dt>
980 <dd>Optional. The TTL to be set on the encapsulating packet.
981 It may also be the word <code>inherit</code>, in which case the
982 TTL will be copied from the inner packet if it is IPv4 or IPv6
983 (otherwise it will be the system default, typically 64).
984 Default is the system default TTL.</dd>
987 <dt><code>pmtud</code></dt>
988 <dd>Optional. Enable tunnel path MTU discovery. If enabled
989 ``ICMP destination unreachable - fragmentation'' needed
990 messages will be generated for IPv4 packets with the DF bit set
991 and IPv6 packets above the minimum MTU if the packet size
992 exceeds the path MTU minus the size of the tunnel headers. It
993 also forces the encapsulating packet DF bit to be set (it is
994 always set if the inner packet implies path MTU discovery).
995 Note that this option causes behavior that is typically
996 reserved for routers and therefore is not entirely in
997 compliance with the IEEE 802.1D specification for bridges.
998 Default is enabled, set to <code>false</code> to disable.</dd>
1001 <dt><code>header_cache</code></dt>
1002 <dd>Optional. Enable caching of tunnel headers and the output
1003 path. This can lead to a significant performance increase
1004 without changing behavior. In general it should not be
1005 necessary to adjust this setting. However, the caching can
1006 bypass certain components of the IP stack (such as IP tables)
1007 and it may be useful to disable it if these features are
1008 required or as a debugging measure. Default is enabled, set to
1009 <code>false</code> to disable.</dd>
1012 <dt><code>patch</code></dt>
1015 A pair of virtual devices that act as a patch cable. The <ref
1016 column="options"/> column must have the following key-value pair:
1019 <dt><code>peer</code></dt>
1021 The <ref column="name"/> of the <ref table="Interface"/> for
1022 the other side of the patch. The named <ref
1023 table="Interface"/>'s own <code>peer</code> option must specify
1024 this <ref table="Interface"/>'s name. That is, the two patch
1025 interfaces must have reversed <ref column="name"/> and
1026 <code>peer</code> values.
1033 <column name="options">
1034 Configuration options whose interpretation varies based on
1035 <ref column="type"/>.
1039 <group title="Interface Status">
1041 Status information about interfaces attached to bridges, updated every
1042 5 seconds. Not all interfaces have all of these properties; virtual
1043 interfaces don't have a link speed, for example. Non-applicable
1044 columns will have empty values.
1046 <column name="admin_state">
1048 The administrative state of the physical network link.
1052 <column name="link_state">
1054 The observed state of the physical network link. This is ordinarily
1055 the link's carrier status. If the interface's <ref table="Port"/> is
1056 a bond configured for miimon monitoring, it is instead the network
1057 link's miimon status.
1061 <column name="link_speed">
1063 The negotiated speed of the physical network link.
1064 Valid values are positive integers greater than 0.
1068 <column name="duplex">
1070 The duplex mode of the physical network link.
1076 The MTU (maximum transmission unit); i.e. the largest
1077 amount of data that can fit into a single Ethernet frame.
1078 The standard Ethernet MTU is 1500 bytes. Some physical media
1079 and many kinds of virtual interfaces can be configured with
1083 This column will be empty for an interface that does not
1084 have an MTU as, for example, some kinds of tunnels do not.
1088 <column name="status">
1090 Key-value pairs that report port status. Supported status
1091 values are <code>type</code>-dependent; some interfaces may not have
1092 a valid <code>driver_name</code>, for example.
1094 <p>The currently defined key-value pairs are:</p>
1096 <dt><code>driver_name</code></dt>
1097 <dd>The name of the device driver controlling the network
1101 <dt><code>driver_version</code></dt>
1102 <dd>The version string of the device driver controlling the
1103 network adapter.</dd>
1106 <dt><code>firmware_version</code></dt>
1107 <dd>The version string of the network adapter's firmware, if
1111 <dt><code>source_ip</code></dt>
1112 <dd>The source IP address used for an IPv4 tunnel end-point,
1113 such as <code>gre</code> or <code>capwap</code>.</dd>
1116 <dt><code>tunnel_egress_iface</code></dt>
1117 <dd>Egress interface for tunnels. Currently only relevant for GRE
1118 and CAPWAP tunnels. On Linux systems, this column will show
1119 the name of the interface which is responsible for routing
1120 traffic destined for the configured <code>remote_ip</code>.
1121 This could be an internal interface such as a bridge port.</dd>
1124 <dt><code>tunnel_egress_iface_carrier</code></dt>
1125 <dd>Whether a carrier is detected on <ref
1126 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1127 and <code>up</code>.</dd>
1132 <group title="Ingress Policing">
1134 These settings control ingress policing for packets received on this
1135 interface. On a physical interface, this limits the rate at which
1136 traffic is allowed into the system from the outside; on a virtual
1137 interface (one connected to a virtual machine), this limits the rate at
1138 which the VM is able to transmit.
1141 Policing is a simple form of quality-of-service that simply drops
1142 packets received in excess of the configured rate. Due to its
1143 simplicity, policing is usually less accurate and less effective than
1144 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1145 table="Queue"/> tables).
1148 Policing is currently implemented only on Linux. The Linux
1149 implementation uses a simple ``token bucket'' approach:
1153 The size of the bucket corresponds to <ref
1154 column="ingress_policing_burst"/>. Initially the bucket is full.
1157 Whenever a packet is received, its size (converted to tokens) is
1158 compared to the number of tokens currently in the bucket. If the
1159 required number of tokens are available, they are removed and the
1160 packet is forwarded. Otherwise, the packet is dropped.
1163 Whenever it is not full, the bucket is refilled with tokens at the
1164 rate specified by <ref column="ingress_policing_rate"/>.
1168 Policing interacts badly with some network protocols, and especially
1169 with fragmented IP packets. Suppose that there is enough network
1170 activity to keep the bucket nearly empty all the time. Then this token
1171 bucket algorithm will forward a single packet every so often, with the
1172 period depending on packet size and on the configured rate. All of the
1173 fragments of an IP packets are normally transmitted back-to-back, as a
1174 group. In such a situation, therefore, only one of these fragments
1175 will be forwarded and the rest will be dropped. IP does not provide
1176 any way for the intended recipient to ask for only the remaining
1177 fragments. In such a case there are two likely possibilities for what
1178 will happen next: either all of the fragments will eventually be
1179 retransmitted (as TCP will do), in which case the same problem will
1180 recur, or the sender will not realize that its packet has been dropped
1181 and data will simply be lost (as some UDP-based protocols will do).
1182 Either way, it is possible that no forward progress will ever occur.
1184 <column name="ingress_policing_rate">
1186 Maximum rate for data received on this interface, in kbps. Data
1187 received faster than this rate is dropped. Set to <code>0</code>
1188 (the default) to disable policing.
1192 <column name="ingress_policing_burst">
1193 <p>Maximum burst size for data received on this interface, in kb. The
1194 default burst size if set to <code>0</code> is 1000 kb. This value
1195 has no effect if <ref column="ingress_policing_rate"/>
1196 is <code>0</code>.</p>
1198 Specifying a larger burst size lets the algorithm be more forgiving,
1199 which is important for protocols like TCP that react severely to
1200 dropped packets. The burst size should be at least the size of the
1201 interface's MTU. Specifying a value that is numerically at least as
1202 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1203 closer to achieving the full rate.
1208 <group title="Other Features">
1210 <column name="monitor">
1211 Connectivity monitor configuration for this interface.
1214 <column name="lacp_current">
1215 Boolean value indicating LACP status for this interface. If true, this
1216 interface has current LACP information about its LACP partner. This
1217 information may be used to monitor the health of interfaces in a LACP
1218 enabled port. This column will be empty if LACP is not enabled.
1221 <column name="external_ids">
1222 Key-value pairs for use by external frameworks that integrate
1223 with Open vSwitch, rather than by Open vSwitch itself. System
1224 integrators should either use the Open vSwitch development
1225 mailing list to coordinate on common key-value definitions, or
1226 choose key names that are likely to be unique. The currently
1227 defined common key-value pairs are:
1229 <dt><code>attached-mac</code></dt>
1231 The MAC address programmed into the ``virtual hardware'' for this
1232 interface, in the form
1233 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1234 For Citrix XenServer, this is the value of the <code>MAC</code>
1235 field in the VIF record for this interface.</dd>
1236 <dt><code>iface-id</code></dt>
1237 <dd>A system-unique identifier for the interface. On XenServer,
1238 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1241 Additionally the following key-value pairs specifically
1242 apply to an interface that represents a virtual Ethernet interface
1243 connected to a virtual machine. These key-value pairs should not be
1244 present for other types of interfaces. Keys whose names end
1245 in <code>-uuid</code> have values that uniquely identify the entity
1246 in question. For a Citrix XenServer hypervisor, these values are
1247 UUIDs in RFC 4122 format. Other hypervisors may use other
1250 <p>The currently defined key-value pairs for XenServer are:</p>
1252 <dt><code>xs-vif-uuid</code></dt>
1253 <dd>The virtual interface associated with this interface.</dd>
1254 <dt><code>xs-network-uuid</code></dt>
1255 <dd>The virtual network to which this interface is attached.</dd>
1256 <dt><code>xs-vm-uuid</code></dt>
1257 <dd>The VM to which this interface belongs.</dd>
1261 <column name="other_config">
1262 Key-value pairs for rarely used interface features.
1264 <dt><code>lacp-port-priority</code></dt>
1265 <dd> The LACP port priority of this <ref table="Interface"/>. In
1266 LACP negotiations <ref table="Interface"/>s with numerically lower
1267 priorities are preferred for aggregation. Must be a number between
1272 <column name="statistics">
1274 Key-value pairs that report interface statistics. The current
1275 implementation updates these counters periodically. In the future,
1276 we plan to, instead, update them when an interface is created, when
1277 they are queried (e.g. using an OVSDB <code>select</code> operation),
1278 and just before an interface is deleted due to virtual interface
1279 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1280 regular periodic basis.</p>
1282 The currently defined key-value pairs are listed below. These are
1283 the same statistics reported by OpenFlow in its <code>struct
1284 ofp_port_stats</code> structure. If an interface does not support a
1285 given statistic, then that pair is omitted.</p>
1288 Successful transmit and receive counters:
1290 <dt><code>rx_packets</code></dt>
1291 <dd>Number of received packets.</dd>
1292 <dt><code>rx_bytes</code></dt>
1293 <dd>Number of received bytes.</dd>
1294 <dt><code>tx_packets</code></dt>
1295 <dd>Number of transmitted packets.</dd>
1296 <dt><code>tx_bytes</code></dt>
1297 <dd>Number of transmitted bytes.</dd>
1303 <dt><code>rx_dropped</code></dt>
1304 <dd>Number of packets dropped by RX.</dd>
1305 <dt><code>rx_frame_err</code></dt>
1306 <dd>Number of frame alignment errors.</dd>
1307 <dt><code>rx_over_err</code></dt>
1308 <dd>Number of packets with RX overrun.</dd>
1309 <dt><code>rx_crc_err</code></dt>
1310 <dd>Number of CRC errors.</dd>
1311 <dt><code>rx_errors</code></dt>
1313 Total number of receive errors, greater than or equal
1314 to the sum of the above.
1321 <dt><code>tx_dropped</code></dt>
1322 <dd>Number of packets dropped by TX.</dd>
1323 <dt><code>collisions</code></dt>
1324 <dd>Number of collisions.</dd>
1325 <dt><code>tx_errors</code></dt>
1327 Total number of transmit errors, greater
1328 than or equal to the sum of the above.
1337 <table name="QoS" title="Quality of Service configuration">
1338 <p>Quality of Service (QoS) configuration for each Port that
1341 <column name="type">
1342 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1343 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1344 identifies the types that a switch actually supports. The currently
1345 defined types are listed below:</p>
1347 <dt><code>linux-htb</code></dt>
1349 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1350 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1351 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1352 for information on how this classifier works and how to configure it.
1356 <dt><code>linux-hfsc</code></dt>
1358 Linux "Hierarchical Fair Service Curve" classifier.
1359 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1360 information on how this classifier works.
1365 <column name="queues">
1366 <p>A map from queue numbers to <ref table="Queue"/> records. The
1367 supported range of queue numbers depend on <ref column="type"/>. The
1368 queue numbers are the same as the <code>queue_id</code> used in
1369 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1370 structures. Queue 0 is used by OpenFlow output actions that do not
1371 specify a specific queue.</p>
1374 <column name="other_config">
1375 <p>Key-value pairs for configuring QoS features that depend on
1376 <ref column="type"/>.</p>
1377 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1378 the following key-value pairs:</p>
1380 <dt><code>max-rate</code></dt>
1381 <dd>Maximum rate shared by all queued traffic, in bit/s.
1382 Optional. If not specified, for physical interfaces, the
1383 default is the link rate. For other interfaces or if the
1384 link rate cannot be determined, the default is currently 100
1389 <column name="external_ids">
1390 Key-value pairs for use by external frameworks that integrate with Open
1391 vSwitch, rather than by Open vSwitch itself. System integrators should
1392 either use the Open vSwitch development mailing list to coordinate on
1393 common key-value definitions, or choose key names that are likely to be
1394 unique. No common key-value pairs are currently defined.
1398 <table name="Queue" title="QoS output queue.">
1399 <p>A configuration for a port output queue, used in configuring Quality of
1400 Service (QoS) features. May be referenced by <ref column="queues"
1401 table="QoS"/> column in <ref table="QoS"/> table.</p>
1403 <column name="other_config">
1404 <p>Key-value pairs for configuring the output queue. The supported
1405 key-value pairs and their meanings depend on the <ref column="type"/>
1406 of the <ref column="QoS"/> records that reference this row.</p>
1407 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1408 column="type"/> of <code>min-rate</code> are:</p>
1410 <dt><code>min-rate</code></dt>
1411 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1412 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1414 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1415 column="type"/> of <code>linux-htb</code> are:</p>
1417 <dt><code>min-rate</code></dt>
1418 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1419 <dt><code>max-rate</code></dt>
1420 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1421 queue's rate will not be allowed to exceed the specified value, even
1422 if excess bandwidth is available. If unspecified, defaults to no
1424 <dt><code>burst</code></dt>
1425 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1426 that a queue can accumulate while it is idle. Optional. Details of
1427 the <code>linux-htb</code> implementation require a minimum burst
1428 size, so a too-small <code>burst</code> will be silently
1430 <dt><code>priority</code></dt>
1431 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1432 unspecified. A queue with a smaller <code>priority</code>
1433 will receive all the excess bandwidth that it can use before
1434 a queue with a larger value receives any. Specific priority
1435 values are unimportant; only relative ordering matters.</dd>
1437 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1438 column="type"/> of <code>linux-hfsc</code> are:</p>
1440 <dt><code>min-rate</code></dt>
1441 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1442 <dt><code>max-rate</code></dt>
1443 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1444 queue's rate will not be allowed to exceed the specified value, even
1445 if excess bandwidth is available. If unspecified, defaults to no
1450 <column name="external_ids">
1451 Key-value pairs for use by external frameworks that integrate with Open
1452 vSwitch, rather than by Open vSwitch itself. System integrators should
1453 either use the Open vSwitch development mailing list to coordinate on
1454 common key-value definitions, or choose key names that are likely to be
1455 unique. No common key-value pairs are currently defined.
1459 <table name="Monitor" title="Connectivity Monitor configuration">
1461 A <ref table="Monitor"/> attaches to an <ref table="Interface"/> to
1462 implement 802.1ag Connectivity Fault Management (CFM). CFM allows a
1463 group of Maintenance Points (MPs) called a Maintenance Association (MA)
1464 to detect connectivity problems with each other. MPs within a MA should
1465 have complete and exclusive interconnectivity. This is verified by
1466 occasionally broadcasting Continuity Check Messages (CCMs) at a
1467 configurable transmission interval. A <ref table="Monitor"/> is
1468 responsible for collecting data about other MPs in its MA and
1472 <group title="Monitor Configuration">
1473 <column name="mpid">
1474 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1475 a Maintenance Association (see <ref column="ma_name"/>). The MPID is
1476 used to identify this <ref table="Monitor"/> to other endpoints in the
1480 <column name="remote_mps">
1481 A set of <ref table="Maintenance_Points"/> which this
1482 <ref table="Monitor"/> should have connectivity to. If this
1483 <ref table="Monitor"/> does not have connectivity to any MPs in this
1484 set, or has connectivity to any MPs not in this set, a fault is
1488 <column name="ma_name">
1489 A Maintenance Association (MA) name pairs with a Maintenance Domain
1490 (MD) name to uniquely identify a MA. A MA is a group of endpoints who
1491 have complete and exclusive interconnectivity. Defaults to
1492 <code>ovs</code> if unset.
1495 <column name="md_name">
1496 A Maintenance Domain name pairs with a Maintenance Association name to
1497 uniquely identify a MA. Defaults to <code>ovs</code> if unset.
1500 <column name="interval">
1501 The transmission interval of CCMs in milliseconds. Three missed CCMs
1502 indicate a connectivity fault. Defaults to 1000ms.
1506 <group title="Monitor Status">
1507 <column name="fault">
1508 Indicates a Connectivity Fault caused by a configuration error, a down
1509 remote MP, or unexpected connectivity to a remote MAID or remote MP.
1514 <table name="Maintenance_Point" title="Maintenance Point configuration">
1516 A <ref table="Maintenance_Point"/> represents a MP which a
1517 <ref table="Monitor"/> has or should have connectivity to.
1520 <group title="Maintenance_Point Configuration">
1521 <column name="mpid">
1522 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1523 a Maintenance Association. All MPs within a MA should have a unique
1528 <group title="Maintenance_Point Status">
1529 <column name="fault">
1530 Indicates a connectivity fault.
1535 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1536 <p>A port mirror within a <ref table="Bridge"/>.</p>
1537 <p>A port mirror configures a bridge to send selected frames to special
1538 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1539 traffic may also be referred to as SPAN or RSPAN, depending on the
1540 mechanism used for delivery.</p>
1542 <column name="name">
1543 Arbitrary identifier for the <ref table="Mirror"/>.
1546 <group title="Selecting Packets for Mirroring">
1548 To be selected for mirroring, a given packet must enter or leave the
1549 bridge through a selected port and it must also be in one of the
1553 <column name="select_all">
1554 If true, every packet arriving or departing on any port is
1555 selected for mirroring.
1558 <column name="select_dst_port">
1559 Ports on which departing packets are selected for mirroring.
1562 <column name="select_src_port">
1563 Ports on which arriving packets are selected for mirroring.
1566 <column name="select_vlan">
1567 VLANs on which packets are selected for mirroring. An empty set
1568 selects packets on all VLANs.
1572 <group title="Mirroring Destination Configuration">
1574 These columns are mutually exclusive. Exactly one of them must be
1578 <column name="output_port">
1579 <p>Output port for selected packets, if nonempty.</p>
1580 <p>Specifying a port for mirror output reserves that port exclusively
1581 for mirroring. No frames other than those selected for mirroring
1582 will be forwarded to the port, and any frames received on the port
1583 will be discarded.</p>
1584 <p>This type of mirroring is sometimes called SPAN.</p>
1587 <column name="output_vlan">
1588 <p>Output VLAN for selected packets, if nonempty.</p>
1589 <p>The frames will be sent out all ports that trunk
1590 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1591 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1592 trunk port, the frame's VLAN tag will be set to
1593 <ref column="output_vlan"/>, replacing any existing tag; when it is
1594 sent out an implicit VLAN port, the frame will not be tagged. This
1595 type of mirroring is sometimes called RSPAN.</p>
1596 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1597 contains unmanaged switches. Consider an unmanaged physical switch
1598 with two ports: port 1, connected to an end host, and port 2,
1599 connected to an Open vSwitch configured to mirror received packets
1600 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1601 port 1 that the physical switch forwards to port 2. The Open vSwitch
1602 forwards this packet to its destination and then reflects it back on
1603 port 2 in VLAN 123. This reflected packet causes the unmanaged
1604 physical switch to replace the MAC learning table entry, which
1605 correctly pointed to port 1, with one that incorrectly points to port
1606 2. Afterward, the physical switch will direct packets destined for
1607 the end host to the Open vSwitch on port 2, instead of to the end
1608 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1609 desired in this scenario, then the physical switch must be replaced
1610 by one that learns Ethernet addresses on a per-VLAN basis. In
1611 addition, learning should be disabled on the VLAN containing mirrored
1612 traffic. If this is not done then intermediate switches will learn
1613 the MAC address of each end host from the mirrored traffic. If
1614 packets being sent to that end host are also mirrored, then they will
1615 be dropped since the switch will attempt to send them out the input
1616 port. Disabling learning for the VLAN will cause the switch to
1617 correctly send the packet out all ports configured for that VLAN. If
1618 Open vSwitch is being used as an intermediate switch, learning can be
1619 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1620 in the appropriate <ref table="Bridge"/> table or tables.</p>
1624 <group title="Other Features">
1625 <column name="external_ids">
1626 Key-value pairs for use by external frameworks that integrate with Open
1627 vSwitch, rather than by Open vSwitch itself. System integrators should
1628 either use the Open vSwitch development mailing list to coordinate on
1629 common key-value definitions, or choose key names that are likely to be
1630 unique. No common key-value pairs are currently defined.
1635 <table name="Controller" title="OpenFlow controller configuration.">
1636 <p>An OpenFlow controller.</p>
1639 Open vSwitch supports two kinds of OpenFlow controllers:
1643 <dt>Primary controllers</dt>
1646 This is the kind of controller envisioned by the OpenFlow 1.0
1647 specification. Usually, a primary controller implements a network
1648 policy by taking charge of the switch's flow table.
1652 Open vSwitch initiates and maintains persistent connections to
1653 primary controllers, retrying the connection each time it fails or
1654 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1655 <ref table="Bridge"/> table applies to primary controllers.
1659 Open vSwitch permits a bridge to have any number of primary
1660 controllers. When multiple controllers are configured, Open
1661 vSwitch connects to all of them simultaneously. Because
1662 OpenFlow 1.0 does not specify how multiple controllers
1663 coordinate in interacting with a single switch, more than
1664 one primary controller should be specified only if the
1665 controllers are themselves designed to coordinate with each
1666 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1667 vendor extension may be useful for this.)
1670 <dt>Service controllers</dt>
1673 These kinds of OpenFlow controller connections are intended for
1674 occasional support and maintenance use, e.g. with
1675 <code>ovs-ofctl</code>. Usually a service controller connects only
1676 briefly to inspect or modify some of a switch's state.
1680 Open vSwitch listens for incoming connections from service
1681 controllers. The service controllers initiate and, if necessary,
1682 maintain the connections from their end. The <ref table="Bridge"
1683 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1684 not apply to service controllers.
1688 Open vSwitch supports configuring any number of service controllers.
1694 The <ref column="target"/> determines the type of controller.
1697 <group title="Core Features">
1698 <column name="target">
1699 <p>Connection method for controller.</p>
1701 The following connection methods are currently supported for primary
1705 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1707 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1708 the given <var>ip</var>, which must be expressed as an IP address
1709 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1710 column in the <ref table="Open_vSwitch"/> table must point to a
1711 valid SSL configuration when this form is used.</p>
1712 <p>SSL support is an optional feature that is not always built as
1713 part of Open vSwitch.</p>
1715 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1716 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1717 the given <var>ip</var>, which must be expressed as an IP address
1718 (not a DNS name).</dd>
1721 The following connection methods are currently supported for service
1725 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1728 Listens for SSL connections on the specified TCP <var>port</var>
1729 (default: 6633). If <var>ip</var>, which must be expressed as an
1730 IP address (not a DNS name), is specified, then connections are
1731 restricted to the specified local IP address.
1734 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1735 table="Open_vSwitch"/> table must point to a valid SSL
1736 configuration when this form is used.
1738 <p>SSL support is an optional feature that is not always built as
1739 part of Open vSwitch.</p>
1741 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1743 Listens for connections on the specified TCP <var>port</var>
1744 (default: 6633). If <var>ip</var>, which must be expressed as an
1745 IP address (not a DNS name), is specified, then connections are
1746 restricted to the specified local IP address.
1749 <p>When multiple controllers are configured for a single bridge, the
1750 <ref column="target"/> values must be unique. Duplicate
1751 <ref column="target"/> values yield unspecified results.</p>
1754 <column name="connection_mode">
1755 <p>If it is specified, this setting must be one of the following
1756 strings that describes how Open vSwitch contacts this OpenFlow
1757 controller over the network:</p>
1760 <dt><code>in-band</code></dt>
1761 <dd>In this mode, this controller's OpenFlow traffic travels over the
1762 bridge associated with the controller. With this setting, Open
1763 vSwitch allows traffic to and from the controller regardless of the
1764 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1765 would never be able to connect to the controller, because it did
1766 not have a flow to enable it.) This is the most common connection
1767 mode because it is not necessary to maintain two independent
1769 <dt><code>out-of-band</code></dt>
1770 <dd>In this mode, OpenFlow traffic uses a control network separate
1771 from the bridge associated with this controller, that is, the
1772 bridge does not use any of its own network devices to communicate
1773 with the controller. The control network must be configured
1774 separately, before or after <code>ovs-vswitchd</code> is started.
1778 <p>If not specified, the default is implementation-specific.</p>
1782 <group title="Controller Failure Detection and Handling">
1783 <column name="max_backoff">
1784 Maximum number of milliseconds to wait between connection attempts.
1785 Default is implementation-specific.
1788 <column name="inactivity_probe">
1789 Maximum number of milliseconds of idle time on connection to
1790 controller before sending an inactivity probe message. If Open
1791 vSwitch does not communicate with the controller for the specified
1792 number of seconds, it will send a probe. If a response is not
1793 received for the same additional amount of time, Open vSwitch
1794 assumes the connection has been broken and attempts to reconnect.
1795 Default is implementation-specific. A value of 0 disables
1800 <group title="OpenFlow Rate Limiting">
1801 <column name="controller_rate_limit">
1802 <p>The maximum rate at which packets in unknown flows will be
1803 forwarded to the OpenFlow controller, in packets per second. This
1804 feature prevents a single bridge from overwhelming the controller.
1805 If not specified, the default is implementation-specific.</p>
1806 <p>In addition, when a high rate triggers rate-limiting, Open
1807 vSwitch queues controller packets for each port and transmits
1808 them to the controller at the configured rate. The number of
1809 queued packets is limited by
1810 the <ref column="controller_burst_limit"/> value. The packet
1811 queue is shared fairly among the ports on a bridge.</p><p>Open
1812 vSwitch maintains two such packet rate-limiters per bridge.
1813 One of these applies to packets sent up to the controller
1814 because they do not correspond to any flow. The other applies
1815 to packets sent up to the controller by request through flow
1816 actions. When both rate-limiters are filled with packets, the
1817 actual rate that packets are sent to the controller is up to
1818 twice the specified rate.</p>
1821 <column name="controller_burst_limit">
1822 In conjunction with <ref column="controller_rate_limit"/>,
1823 the maximum number of unused packet credits that the bridge will
1824 allow to accumulate, in packets. If not specified, the default
1825 is implementation-specific.
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"/>).</p>
1833 <p>When multiple controllers are configured on a single bridge, there
1834 should be only one set of unique values in these columns. If different
1835 values are set for these columns in different controllers, the effect
1838 <column name="local_ip">
1839 The IP address to configure on the local port,
1840 e.g. <code>192.168.0.123</code>. If this value is unset, then
1841 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1845 <column name="local_netmask">
1846 The IP netmask to configure on the local port,
1847 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1848 but this value is unset, then the default is chosen based on whether
1849 the IP address is class A, B, or C.
1852 <column name="local_gateway">
1853 The IP address of the gateway to configure on the local port, as a
1854 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1855 this network has no gateway.
1859 <group title="Other Features">
1860 <column name="external_ids">
1861 Key-value pairs for use by external frameworks that integrate with Open
1862 vSwitch, rather than by Open vSwitch itself. System integrators should
1863 either use the Open vSwitch development mailing list to coordinate on
1864 common key-value definitions, or choose key names that are likely to be
1865 unique. No common key-value pairs are currently defined.
1869 <group title="Controller Status">
1870 <column name="is_connected">
1871 <code>true</code> if currently connected to this controller,
1872 <code>false</code> otherwise.
1875 <column name="role">
1876 <p>The level of authority this controller has on the associated
1877 bridge. Possible values are:</p>
1879 <dt><code>other</code></dt>
1880 <dd>Allows the controller access to all OpenFlow features.</dd>
1881 <dt><code>master</code></dt>
1882 <dd>Equivalent to <code>other</code>, except that there may be at
1883 most one master controller at a time. When a controller configures
1884 itself as <code>master</code>, any existing master is demoted to
1885 the <code>slave</code>role.</dd>
1886 <dt><code>slave</code></dt>
1887 <dd>Allows the controller read-only access to OpenFlow features.
1888 Attempts to modify the flow table will be rejected with an
1889 error. Slave controllers do not receive OFPT_PACKET_IN or
1890 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1895 <column name="status">
1896 <p>Key-value pairs that report controller status.</p>
1898 <dt><code>last_error</code></dt>
1899 <dd>A human-readable description of the last error on the connection
1900 to the controller; i.e. <code>strerror(errno)</code>. This key
1901 will exist only if an error has occurred.</dd>
1902 <dt><code>state</code></dt>
1903 <dd>The state of the connection to the controller. Possible values
1904 are: <code>VOID</code> (connection is disabled),
1905 <code>BACKOFF</code> (attempting to reconnect at an increasing
1906 period), <code>CONNECTING</code> (attempting to connect),
1907 <code>ACTIVE</code> (connected, remote host responsive), and
1908 <code>IDLE</code> (remote host idle, sending keep-alive). These
1909 values may change in the future. They are provided only for human
1911 <dt><code>sec_since_connect</code></dt>
1912 <dd>The amount of time since this controller last successfully
1913 connected to the switch (in seconds). Value is empty if controller
1914 has never successfully connected.</dd>
1915 <dt><code>sec_since_disconnect</code></dt>
1916 <dd>The amount of time since this controller last disconnected from
1917 the switch (in seconds). Value is empty if controller has never
1924 <table name="Manager" title="OVSDB management connection.">
1926 Configuration for a database connection to an Open vSwitch database
1931 This table primarily configures the Open vSwitch database
1932 (<code>ovsdb-server</code>), not the Open vSwitch switch
1933 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1934 what connections should be treated as in-band.
1938 The Open vSwitch database server can initiate and maintain active
1939 connections to remote clients. It can also listen for database
1943 <group title="Core Features">
1944 <column name="target">
1945 <p>Connection method for managers.</p>
1947 The following connection methods are currently supported:
1950 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1953 The specified SSL <var>port</var> (default: 6632) on the host at
1954 the given <var>ip</var>, which must be expressed as an IP address
1955 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1956 column in the <ref table="Open_vSwitch"/> table must point to a
1957 valid SSL configuration when this form is used.
1960 SSL support is an optional feature that is not always built as
1961 part of Open vSwitch.
1965 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1967 The specified TCP <var>port</var> (default: 6632) on the host at
1968 the given <var>ip</var>, which must be expressed as an IP address
1971 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1974 Listens for SSL connections on the specified TCP <var>port</var>
1975 (default: 6632). If <var>ip</var>, which must be expressed as an
1976 IP address (not a DNS name), is specified, then connections are
1977 restricted to the specified local IP address.
1980 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1981 table="Open_vSwitch"/> table must point to a valid SSL
1982 configuration when this form is used.
1985 SSL support is an optional feature that is not always built as
1986 part of Open vSwitch.
1989 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1991 Listens for connections on the specified TCP <var>port</var>
1992 (default: 6632). If <var>ip</var>, which must be expressed as an
1993 IP address (not a DNS name), is specified, then connections are
1994 restricted to the specified local IP address.
1997 <p>When multiple managers are configured, the <ref column="target"/>
1998 values must be unique. Duplicate <ref column="target"/> values yield
1999 unspecified results.</p>
2002 <column name="connection_mode">
2004 If it is specified, this setting must be one of the following strings
2005 that describes how Open vSwitch contacts this OVSDB client over the
2010 <dt><code>in-band</code></dt>
2012 In this mode, this connection's traffic travels over a bridge
2013 managed by Open vSwitch. With this setting, Open vSwitch allows
2014 traffic to and from the client regardless of the contents of the
2015 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2016 to connect to the client, because it did not have a flow to enable
2017 it.) This is the most common connection mode because it is not
2018 necessary to maintain two independent networks.
2020 <dt><code>out-of-band</code></dt>
2022 In this mode, the client's traffic uses a control network separate
2023 from that managed by Open vSwitch, that is, Open vSwitch does not
2024 use any of its own network devices to communicate with the client.
2025 The control network must be configured separately, before or after
2026 <code>ovs-vswitchd</code> is started.
2031 If not specified, the default is implementation-specific.
2036 <group title="Client Failure Detection and Handling">
2037 <column name="max_backoff">
2038 Maximum number of milliseconds to wait between connection attempts.
2039 Default is implementation-specific.
2042 <column name="inactivity_probe">
2043 Maximum number of milliseconds of idle time on connection to the client
2044 before sending an inactivity probe message. If Open vSwitch does not
2045 communicate with the client for the specified number of seconds, it
2046 will send a probe. If a response is not received for the same
2047 additional amount of time, Open vSwitch assumes the connection has been
2048 broken and attempts to reconnect. Default is implementation-specific.
2049 A value of 0 disables inactivity probes.
2053 <group title="Other Features">
2054 <column name="external_ids">
2055 Key-value pairs for use by external frameworks that integrate with Open
2056 vSwitch, rather than by Open vSwitch itself. System integrators should
2057 either use the Open vSwitch development mailing list to coordinate on
2058 common key-value definitions, or choose key names that are likely to be
2059 unique. No common key-value pairs are currently defined.
2063 <group title="Status">
2064 <column name="is_connected">
2065 <code>true</code> if currently connected to this manager,
2066 <code>false</code> otherwise.
2069 <column name="status">
2070 <p>Key-value pairs that report manager status.</p>
2072 <dt><code>last_error</code></dt>
2073 <dd>A human-readable description of the last error on the connection
2074 to the manager; i.e. <code>strerror(errno)</code>. This key
2075 will exist only if an error has occurred.</dd>
2078 <dt><code>state</code></dt>
2079 <dd>The state of the connection to the manager. Possible values
2080 are: <code>VOID</code> (connection is disabled),
2081 <code>BACKOFF</code> (attempting to reconnect at an increasing
2082 period), <code>CONNECTING</code> (attempting to connect),
2083 <code>ACTIVE</code> (connected, remote host responsive), and
2084 <code>IDLE</code> (remote host idle, sending keep-alive). These
2085 values may change in the future. They are provided only for human
2089 <dt><code>sec_since_connect</code></dt>
2090 <dd>The amount of time since this manager last successfully connected
2091 to the database (in seconds). Value is empty if manager has never
2092 successfully connected.</dd>
2095 <dt><code>sec_since_disconnect</code></dt>
2096 <dd>The amount of time since this manager last disconnected from the
2097 database (in seconds). Value is empty if manager has never
2104 <table name="NetFlow">
2105 A NetFlow target. NetFlow is a protocol that exports a number of
2106 details about terminating IP flows, such as the principals involved
2109 <column name="targets">
2110 NetFlow targets in the form
2111 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2112 must be specified numerically, not as a DNS name.
2115 <column name="engine_id">
2116 Engine ID to use in NetFlow messages. Defaults to datapath index
2120 <column name="engine_type">
2121 Engine type to use in NetFlow messages. Defaults to datapath
2122 index if not specified.
2125 <column name="active_timeout">
2126 The interval at which NetFlow records are sent for flows that are
2127 still active, in seconds. A value of <code>0</code> requests the
2128 default timeout (currently 600 seconds); a value of <code>-1</code>
2129 disables active timeouts.
2132 <column name="add_id_to_interface">
2133 <p>If this column's value is <code>false</code>, the ingress and egress
2134 interface fields of NetFlow flow records are derived from OpenFlow port
2135 numbers. When it is <code>true</code>, the 7 most significant bits of
2136 these fields will be replaced by the least significant 7 bits of the
2137 engine id. This is useful because many NetFlow collectors do not
2138 expect multiple switches to be sending messages from the same host, so
2139 they do not store the engine information which could be used to
2140 disambiguate the traffic.</p>
2141 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2144 <column name="external_ids">
2145 Key-value pairs for use by external frameworks that integrate with Open
2146 vSwitch, rather than by Open vSwitch itself. System integrators should
2147 either use the Open vSwitch development mailing list to coordinate on
2148 common key-value definitions, or choose key names that are likely to be
2149 unique. No common key-value pairs are currently defined.
2154 SSL configuration for an Open_vSwitch.
2156 <column name="private_key">
2157 Name of a PEM file containing the private key used as the switch's
2158 identity for SSL connections to the controller.
2161 <column name="certificate">
2162 Name of a PEM file containing a certificate, signed by the
2163 certificate authority (CA) used by the controller and manager,
2164 that certifies the switch's private key, identifying a trustworthy
2168 <column name="ca_cert">
2169 Name of a PEM file containing the CA certificate used to verify
2170 that the switch is connected to a trustworthy controller.
2173 <column name="bootstrap_ca_cert">
2174 If set to <code>true</code>, then Open vSwitch will attempt to
2175 obtain the CA certificate from the controller on its first SSL
2176 connection and save it to the named PEM file. If it is successful,
2177 it will immediately drop the connection and reconnect, and from then
2178 on all SSL connections must be authenticated by a certificate signed
2179 by the CA certificate thus obtained. <em>This option exposes the
2180 SSL connection to a man-in-the-middle attack obtaining the initial
2181 CA certificate.</em> It may still be useful for bootstrapping.
2184 <column name="external_ids">
2185 Key-value pairs for use by external frameworks that integrate with Open
2186 vSwitch, rather than by Open vSwitch itself. System integrators should
2187 either use the Open vSwitch development mailing list to coordinate on
2188 common key-value definitions, or choose key names that are likely to be
2189 unique. No common key-value pairs are currently defined.
2193 <table name="sFlow">
2194 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2197 <column name="agent">
2198 Name of the network device whose IP address should be reported as the
2199 ``agent address'' to collectors. If not specified, the IP address
2200 defaults to the <ref table="Controller" column="local_ip"/> in the
2201 collector's <ref table="Controller"/>. If an agent IP address cannot be
2202 determined either way, sFlow is disabled.
2205 <column name="header">
2206 Number of bytes of a sampled packet to send to the collector.
2207 If not specified, the default is 128 bytes.
2210 <column name="polling">
2211 Polling rate in seconds to send port statistics to the collector.
2212 If not specified, defaults to 30 seconds.
2215 <column name="sampling">
2216 Rate at which packets should be sampled and sent to the collector.
2217 If not specified, defaults to 400, which means one out of 400
2218 packets, on average, will be sent to the collector.
2221 <column name="targets">
2222 sFlow targets in the form
2223 <code><var>ip</var>:<var>port</var></code>.
2226 <column name="external_ids">
2227 Key-value pairs for use by external frameworks that integrate with Open
2228 vSwitch, rather than by Open vSwitch itself. System integrators should
2229 either use the Open vSwitch development mailing list to coordinate on
2230 common key-value definitions, or choose key names that are likely to be
2231 unique. No common key-value pairs are currently defined.
2235 <table name="Capability">
2236 <p>Records in this table describe functionality supported by the hardware
2237 and software platform on which this Open vSwitch is based. Clients
2238 should not modify this table.</p>
2240 <p>A record in this table is meaningful only if it is referenced by the
2241 <ref table="Open_vSwitch" column="capabilities"/> column in the
2242 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2243 the record's ``category,'' determines the meanings of the
2244 <ref column="details"/> column. The following general forms of
2245 categories are currently defined:</p>
2248 <dt><code>qos-<var>type</var></code></dt>
2249 <dd><var>type</var> is supported as the value for
2250 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2254 <column name="details">
2255 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2256 depends on the category key that the <ref table="Open_vSwitch"
2257 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2258 uses to reference this record, as described above.</p>
2260 <p>The presence of a record for category <code>qos-<var>type</var></code>
2261 indicates that the switch supports <var>type</var> as the value of
2262 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2263 table. The following key-value pairs are defined to further describe
2264 QoS capabilities:</p>
2267 <dt><code>n-queues</code></dt>
2268 <dd>Number of supported queues, as a positive integer. Keys in the
2269 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2270 records whose <ref table="QoS" column="type"/> value
2271 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob