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.0</code>.
232 If Open vSwitch was configured with a build number, then it is
233 also included, e.g. <code>1.1.0+build6579</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 modes require the upstream switch to support 802.3ad with
537 successful LACP negotiation. If LACP negotiation fails then
538 <code>balance-slb</code> style flow hashing 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
551 <dt><code>stable</code></dt>
553 <p>Attempts to always assign a given flow to the same slave
554 consistently. In an effort to maintain stability, no load
555 balancing is done. Uses a similar hashing strategy to
556 <code>balance-tcp</code>, always taking into account L3 and L4
557 fields even if LACP negotiations are unsuccessful. </p>
558 <p>Slave selection decisions are made based on
559 <code>bond-stable-id</code> if set. Otherwise, OpenFlow port
560 number is used. Decisions are consistent across all ovs-vswitchd
561 instances with equivalent <code>bond-stable-id</code>s.</p>
565 <p>These columns apply only to bonded ports. Their values are
566 otherwise ignored.</p>
568 <column name="bond_mode">
569 <p>The type of bonding used for a bonded port. Defaults to
570 <code>balance-slb</code> if unset.
574 <column name="bond_updelay">
575 <p>For a bonded port, the number of milliseconds for which carrier must
576 stay up on an interface before the interface is considered to be up.
577 Specify <code>0</code> to enable the interface immediately.</p>
578 <p>This setting is honored only when at least one bonded interface is
579 already enabled. When no interfaces are enabled, then the first bond
580 interface to come up is enabled immediately.</p>
583 <column name="bond_downdelay">
584 For a bonded port, the number of milliseconds for which carrier must
585 stay down on an interface before the interface is considered to be
586 down. Specify <code>0</code> to disable the interface immediately.
589 <column name="bond_fake_iface">
590 For a bonded port, whether to create a fake internal interface with the
591 name of the port. Use only for compatibility with legacy software that
596 <p>Configures LACP on this port. LACP allows directly connected
597 switches to negotiate which links may be bonded. LACP may be enabled
598 on non-bonded ports for the benefit of any switches they may be
599 connected to. <code>active</code> ports are allowed to initiate LACP
600 negotiations. <code>passive</code> ports are allowed to participate
601 in LACP negotiations initiated by a remote switch, but not allowed to
602 initiate such negotiations themselves. If unset Open vSwitch will
603 choose a reasonable default. </p>
608 <group title="Other Features">
610 Quality of Service configuration for this port.
614 The MAC address to use for this port for the purpose of choosing the
615 bridge's MAC address. This column does not necessarily reflect the
616 port's actual MAC address, nor will setting it change the port's actual
620 <column name="fake_bridge">
621 Does this port represent a sub-bridge for its tagged VLAN within the
622 Bridge? See ovs-vsctl(8) for more information.
625 <column name="external_ids">
627 Key-value pairs for use by external frameworks that integrate with
628 Open vSwitch, rather than by Open vSwitch itself. System integrators
629 should either use the Open vSwitch development mailing list to
630 coordinate on common key-value definitions, or choose key names that
631 are likely to be unique.
634 No key-value pairs native to <ref table="Port"/> are currently
635 defined. For fake bridges (see the <ref column="fake_bridge"/>
636 column), external IDs for the fake bridge are defined here by
637 prefixing a <ref table="Bridge"/> <ref table="Bridge"
638 column="external_ids"/> key with <code>fake-bridge-</code>,
639 e.g. <code>fake-bridge-xs-network-uuids</code>.
643 <column name="other_config">
644 Key-value pairs for configuring rarely used port features. The
645 currently defined key-value pairs are:
647 <dt><code>hwaddr</code></dt>
648 <dd>An Ethernet address in the form
649 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
650 <dt><code>bond-rebalance-interval</code></dt>
651 <dd>For an SLB bonded port, the number of milliseconds between
652 successive attempts to rebalance the bond, that is, to
653 move source MACs and their flows from one interface on
654 the bond to another in an attempt to keep usage of each
655 interface roughly equal. The default is 10000 (10
656 seconds), and the minimum is 1000 (1 second).</dd>
657 <dt><code>bond-detect-mode</code></dt>
658 <dd> Sets the method used to detect link failures in a bonded port.
659 Options are <code>carrier</code> and <code>miimon</code>. Defaults
660 to <code>carrier</code> which uses each interface's carrier to detect
661 failures. When set to <code>miimon</code>, will check for failures
662 by polling each interface's MII. </dd>
663 <dt><code>bond-miimon-interval</code></dt>
664 <dd> The number of milliseconds between successive attempts to
665 poll each interface's MII. Only relevant on ports which use
666 <code>miimon</code> to detect failures. </dd>
667 <dt><code>bond-hash-basis</code></dt>
668 <dd> An integer hashed along with flows when choosing output slaves.
669 When changed, all flows will be assigned different hash values
670 possibly causing slave selection decisions to change.</dd>
671 <dt><code>lacp-system-id</code></dt>
672 <dd> The LACP system ID of this <ref table="Port"/>. The system ID
673 of a LACP bond is used to identify itself to its partners. Must
674 be a nonzero MAC address.</dd>
675 <dt><code>lacp-system-priority</code></dt>
676 <dd> The LACP system priority of this <ref table="Port"/>. In
677 LACP negotiations, link status decisions are made by the system
678 with the numerically lower priority. Must be a number between 1
680 <dt><code>lacp-time</code></dt>
682 <p>The LACP timing which should be used on this
683 <ref table="Port"/>. Possible values are <code>fast</code>,
684 <code>slow</code> and a positive number of milliseconds. By
685 default <code>slow</code> is used. When configured to be
686 <code>fast</code> LACP heartbeats are requested at a rate of once
687 per second causing connectivity problems to be detected more
688 quickly. In <code>slow</code> mode, heartbeats are requested at
689 a rate of once every 30 seconds.</p>
691 <p>Users may manually set a heartbeat transmission rate to increase
692 the fault detection speed further. When manually set, OVS
693 expects the partner switch to be configured with the same
694 transmission rate. Manually setting <code>lacp-time</code> to
695 something other than <code>fast</code> or <code>slow</code> is
696 not supported by the LACP specification.</p>
698 <dt><code>lacp-heartbeat</code></dt>
699 <dd> Treats LACP like a simple heartbeat protocol for link state
700 monitoring. Most features of the LACP protocol are disabled when
701 this mode is in use.</dd>
707 <table name="Interface" title="One physical network device in a Port.">
708 An interface within a <ref table="Port"/>.
710 <group title="Core Features">
712 Interface name. Should be alphanumeric and no more than about 8 bytes
713 long. May be the same as the port name, for non-bonded ports. Must
714 otherwise be unique among the names of ports, interfaces, and bridges
719 <p>Ethernet address to set for this interface. If unset then the
720 default MAC address is used:</p>
722 <li>For the local interface, the default is the lowest-numbered MAC
723 address among the other bridge ports, either the value of the
724 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
725 if set, or its actual MAC (for bonded ports, the MAC of its slave
726 whose name is first in alphabetical order). Internal ports and
727 bridge ports that are used as port mirroring destinations (see the
728 <ref table="Mirror"/> table) are ignored.</li>
729 <li>For other internal interfaces, the default MAC is randomly
731 <li>External interfaces typically have a MAC address associated with
734 <p>Some interfaces may not have a software-controllable MAC
738 <column name="ofport">
739 <p>OpenFlow port number for this interface. Unlike most columns, this
740 column's value should be set only by Open vSwitch itself. Other
741 clients should set this column to an empty set (the default) when
742 creating an <ref table="Interface"/>.</p>
743 <p>Open vSwitch populates this column when the port number becomes
744 known. If the interface is successfully added,
745 <ref column="ofport"/> will be set to a number between 1 and 65535
746 (generally either in the range 1 to 65279, inclusive, or 65534, the
747 port number for the OpenFlow ``local port''). If the interface
748 cannot be added then Open vSwitch sets this column
753 <group title="System-Specific Details">
755 The interface type, one of:
757 <dt><code>system</code></dt>
758 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
759 Sometimes referred to as ``external interfaces'' since they are
760 generally connected to hardware external to that on which the Open
761 vSwitch is running. The empty string is a synonym for
762 <code>system</code>.</dd>
763 <dt><code>internal</code></dt>
764 <dd>A simulated network device that sends and receives traffic. An
765 internal interface whose <ref column="name"/> is the same as its
766 bridge's <ref table="Open_vSwitch" column="name"/> is called the
767 ``local interface.'' It does not make sense to bond an internal
768 interface, so the terms ``port'' and ``interface'' are often used
769 imprecisely for internal interfaces.</dd>
770 <dt><code>tap</code></dt>
771 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
772 <dt><code>gre</code></dt>
773 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
774 tunnel. Each tunnel must be uniquely identified by the
775 combination of <code>remote_ip</code>, <code>local_ip</code>, and
776 <code>in_key</code>. Note that if two ports are defined that are
777 the same except one has an optional identifier and the other does
778 not, the more specific one is matched first. <code>in_key</code>
779 is considered more specific than <code>local_ip</code> if a port
780 defines one and another port defines the other. The following
781 options may be specified in the <ref column="options"/> column:
783 <dt><code>remote_ip</code></dt>
784 <dd>Required. The tunnel endpoint.</dd>
787 <dt><code>local_ip</code></dt>
788 <dd>Optional. The destination IP that received packets must
789 match. Default is to match all addresses.</dd>
792 <dt><code>in_key</code></dt>
793 <dd>Optional. The GRE key that received packets must contain.
794 It may either be a 32-bit number (no key and a key of 0 are
795 treated as equivalent) or the word <code>flow</code>. If
796 <code>flow</code> is specified then any key will be accepted
797 and the key will be placed in the <code>tun_id</code> field
798 for matching in the flow table. The ovs-ofctl manual page
799 contains additional information about matching fields in
800 OpenFlow flows. Default is no key.</dd>
803 <dt><code>out_key</code></dt>
804 <dd>Optional. The GRE key to be set on outgoing packets. It may
805 either be a 32-bit number or the word <code>flow</code>. If
806 <code>flow</code> is specified then the key may be set using
807 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
808 is used in the absence of an action). The ovs-ofctl manual
809 page contains additional information about the Nicira OpenFlow
810 vendor extensions. Default is no key.</dd>
813 <dt><code>key</code></dt>
814 <dd>Optional. Shorthand to set <code>in_key</code> and
815 <code>out_key</code> at the same time.</dd>
818 <dt><code>tos</code></dt>
819 <dd>Optional. The value of the ToS bits to be set on the
820 encapsulating packet. It may also be the word
821 <code>inherit</code>, in which case the ToS will be copied from
822 the inner packet if it is IPv4 or IPv6 (otherwise it will be
823 0). Note that the ECN fields are always inherited. Default is
827 <dt><code>ttl</code></dt>
828 <dd>Optional. The TTL to be set on the encapsulating packet.
829 It may also be the word <code>inherit</code>, in which case the
830 TTL will be copied from the inner packet if it is IPv4 or IPv6
831 (otherwise it will be the system default, typically 64).
832 Default is the system default TTL.</dd>
835 <dt><code>csum</code></dt>
836 <dd>Optional. Compute GRE checksums on outgoing packets.
837 Checksums present on incoming packets will be validated
838 regardless of this setting. Note that GRE checksums
839 impose a significant performance penalty as they cover the
840 entire packet. As the contents of the packet is typically
841 covered by L3 and L4 checksums, this additional checksum only
842 adds value for the GRE and encapsulated Ethernet headers.
843 Default is disabled, set to <code>true</code> to enable.</dd>
846 <dt><code>df_inherit</code></dt>
847 <dd>Optional. If enabled, the Don't Fragment bit will be copied
848 from the inner IP headers (those of the encapsulated traffic)
849 to the outer (tunnel) headers. Default is disabled; set to
850 <code>true</code> to enable.</dd>
853 <dt><code>df_default</code></dt>
854 <dd>Optional. If enabled, the Don't Fragment bit will be set by
855 default on tunnel headers if the <code>df_inherit</code> option
856 is not set, or if the encapsulated packet is not IP. Default
857 is enabled; set to <code>false</code> to disable.</dd>
860 <dt><code>pmtud</code></dt>
861 <dd>Optional. Enable tunnel path MTU discovery. If enabled
862 ``ICMP Destination Unreachable - Fragmentation Needed''
863 messages will be generated for IPv4 packets with the DF bit set
864 and IPv6 packets above the minimum MTU if the packet size
865 exceeds the path MTU minus the size of the tunnel headers.
866 Note that this option causes behavior that is typically
867 reserved for routers and therefore is not entirely in
868 compliance with the IEEE 802.1D specification for bridges.
869 Default is enabled; set to <code>false</code> to disable.</dd>
872 <dt><code>header_cache</code></dt>
873 <dd>Optional. Enable caching of tunnel headers and the output
874 path. This can lead to a significant performance increase
875 without changing behavior. In general it should not be
876 necessary to adjust this setting. However, the caching can
877 bypass certain components of the IP stack (such as IP tables)
878 and it may be useful to disable it if these features are
879 required or as a debugging measure. Default is enabled, set to
880 <code>false</code> to disable.</dd>
883 <dt><code>ipsec_gre</code></dt>
884 <dd>An Ethernet over RFC 2890 Generic Routing Encapsulation
885 over IPv4 IPsec tunnel. Each tunnel (including those of type
886 <code>gre</code>) must be uniquely identified by the
887 combination of <code>remote_ip</code> and
888 <code>local_ip</code>. Note that if two ports are defined
889 that are the same except one has an optional identifier and
890 the other does not, the more specific one is matched first.
891 An authentication method of <code>peer_cert</code> or
892 <code>psk</code> must be defined. The following options may
893 be specified in the <ref column="options"/> column:
895 <dt><code>remote_ip</code></dt>
896 <dd>Required. The tunnel endpoint.</dd>
899 <dt><code>local_ip</code></dt>
900 <dd>Optional. The destination IP that received packets must
901 match. Default is to match all addresses.</dd>
904 <dt><code>peer_cert</code></dt>
905 <dd>Required for certificate authentication. A string
906 containing the peer's certificate in PEM format.
907 Additionally the host's certificate must be specified
908 with the <code>certificate</code> option.</dd>
911 <dt><code>certificate</code></dt>
912 <dd>Required for certificate authentication. The name of a
913 PEM file containing a certificate that will be presented
914 to the peer during authentication.</dd>
917 <dt><code>private_key</code></dt>
918 <dd>Optional for certificate authentication. The name of
919 a PEM file containing the private key associated with
920 <code>certificate</code>. If <code>certificate</code>
921 contains the private key, this option may be omitted.</dd>
924 <dt><code>psk</code></dt>
925 <dd>Required for pre-shared key authentication. Specifies a
926 pre-shared key for authentication that must be identical on
927 both sides of the tunnel.</dd>
930 <dt><code>in_key</code></dt>
931 <dd>Optional. The GRE key that received packets must contain.
932 It may either be a 32-bit number (no key and a key of 0 are
933 treated as equivalent) or the word <code>flow</code>. If
934 <code>flow</code> is specified then any key will be accepted
935 and the key will be placed in the <code>tun_id</code> field
936 for matching in the flow table. The ovs-ofctl manual page
937 contains additional information about matching fields in
938 OpenFlow flows. Default is no key.</dd>
941 <dt><code>out_key</code></dt>
942 <dd>Optional. The GRE key to be set on outgoing packets. It may
943 either be a 32-bit number or the word <code>flow</code>. If
944 <code>flow</code> is specified then the key may be set using
945 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
946 is used in the absence of an action). The ovs-ofctl manual
947 page contains additional information about the Nicira OpenFlow
948 vendor extensions. Default is no key.</dd>
951 <dt><code>key</code></dt>
952 <dd>Optional. Shorthand to set <code>in_key</code> and
953 <code>out_key</code> at the same time.</dd>
956 <dt><code>tos</code></dt>
957 <dd>Optional. The value of the ToS bits to be set on the
958 encapsulating packet. It may also be the word
959 <code>inherit</code>, in which case the ToS will be copied from
960 the inner packet if it is IPv4 or IPv6 (otherwise it will be
961 0). Note that the ECN fields are always inherited. Default is
965 <dt><code>ttl</code></dt>
966 <dd>Optional. The TTL to be set on the encapsulating packet.
967 It may also be the word <code>inherit</code>, in which case the
968 TTL will be copied from the inner packet if it is IPv4 or IPv6
969 (otherwise it will be the system default, typically 64).
970 Default is the system default TTL.</dd>
973 <dt><code>csum</code></dt>
974 <dd>Optional. Compute GRE checksums on outgoing packets.
975 Checksums present on incoming packets will be validated
976 regardless of this setting. Note that GRE checksums
977 impose a significant performance penalty as they cover the
978 entire packet. As the contents of the packet is typically
979 covered by L3 and L4 checksums, this additional checksum only
980 adds value for the GRE and encapsulated Ethernet headers.
981 Default is disabled, set to <code>true</code> to enable.</dd>
984 <dt><code>df_inherit</code></dt>
985 <dd>Optional. If enabled, the Don't Fragment bit will be copied
986 from the inner IP headers (those of the encapsulated traffic)
987 to the outer (tunnel) headers. Default is disabled; set to
988 <code>true</code> to enable.</dd>
991 <dt><code>df_default</code></dt>
992 <dd>Optional. If enabled, the Don't Fragment bit will be set by
993 default on tunnel headers if the <code>df_inherit</code> option
994 is not set, or if the encapsulated packet is not IP. Default
995 is enabled; set to <code>false</code> to disable.</dd>
998 <dt><code>pmtud</code></dt>
999 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1000 ``ICMP Destination Unreachable - Fragmentation Needed''
1001 messages will be generated for IPv4 packets with the DF bit set
1002 and IPv6 packets above the minimum MTU if the packet size
1003 exceeds the path MTU minus the size of the tunnel headers.
1004 Note that this option causes behavior that is typically
1005 reserved for routers and therefore is not entirely in
1006 compliance with the IEEE 802.1D specification for bridges.
1007 Default is enabled; set to <code>false</code> to disable.</dd>
1010 <dt><code>capwap</code></dt>
1011 <dd>Ethernet tunneling over the UDP transport portion of CAPWAP
1012 (RFC 5415). This allows interoperability with certain switches
1013 where GRE is not available. Note that only the tunneling component
1014 of the protocol is implemented. Due to the non-standard use of
1015 CAPWAP, UDP ports 58881 and 58882 are used as the source and
1016 destination ports respectively. Each tunnel must be uniquely
1017 identified by the combination of <code>remote_ip</code> and
1018 <code>local_ip</code>. If two ports are defined that are the same
1019 except one includes <code>local_ip</code> and the other does not,
1020 the more specific one is matched first. CAPWAP support is not
1021 available on all platforms. Currently it is only supported in the
1022 Linux kernel module with kernel versions >= 2.6.25. The following
1023 options may be specified in the <ref column="options"/> column:
1025 <dt><code>remote_ip</code></dt>
1026 <dd>Required. The tunnel endpoint.</dd>
1029 <dt><code>local_ip</code></dt>
1030 <dd>Optional. The destination IP that received packets must
1031 match. Default is to match all addresses.</dd>
1034 <dt><code>tos</code></dt>
1035 <dd>Optional. The value of the ToS bits to be set on the
1036 encapsulating packet. It may also be the word
1037 <code>inherit</code>, in which case the ToS will be copied from
1038 the inner packet if it is IPv4 or IPv6 (otherwise it will be
1039 0). Note that the ECN fields are always inherited. Default is
1043 <dt><code>ttl</code></dt>
1044 <dd>Optional. The TTL to be set on the encapsulating packet.
1045 It may also be the word <code>inherit</code>, in which case the
1046 TTL will be copied from the inner packet if it is IPv4 or IPv6
1047 (otherwise it will be the system default, typically 64).
1048 Default is the system default TTL.</dd>
1051 <dt><code>df_inherit</code></dt>
1052 <dd>Optional. If enabled, the Don't Fragment bit will be copied
1053 from the inner IP headers (those of the encapsulated traffic)
1054 to the outer (tunnel) headers. Default is disabled; set to
1055 <code>true</code> to enable.</dd>
1058 <dt><code>df_default</code></dt>
1059 <dd>Optional. If enabled, the Don't Fragment bit will be set by
1060 default on tunnel headers if the <code>df_inherit</code> option
1061 is not set, or if the encapsulated packet is not IP. Default
1062 is enabled; set to <code>false</code> to disable.</dd>
1065 <dt><code>pmtud</code></dt>
1066 <dd>Optional. Enable tunnel path MTU discovery. If enabled
1067 ``ICMP Destination Unreachable - Fragmentation Needed''
1068 messages will be generated for IPv4 packets with the DF bit set
1069 and IPv6 packets above the minimum MTU if the packet size
1070 exceeds the path MTU minus the size of the tunnel headers.
1071 Note that this option causes behavior that is typically
1072 reserved for routers and therefore is not entirely in
1073 compliance with the IEEE 802.1D specification for bridges.
1074 Default is enabled; set to <code>false</code> to disable.</dd>
1077 <dt><code>header_cache</code></dt>
1078 <dd>Optional. Enable caching of tunnel headers and the output
1079 path. This can lead to a significant performance increase
1080 without changing behavior. In general it should not be
1081 necessary to adjust this setting. However, the caching can
1082 bypass certain components of the IP stack (such as IP tables)
1083 and it may be useful to disable it if these features are
1084 required or as a debugging measure. Default is enabled, set to
1085 <code>false</code> to disable.</dd>
1088 <dt><code>patch</code></dt>
1091 A pair of virtual devices that act as a patch cable. The <ref
1092 column="options"/> column must have the following key-value pair:
1095 <dt><code>peer</code></dt>
1097 The <ref column="name"/> of the <ref table="Interface"/> for
1098 the other side of the patch. The named <ref
1099 table="Interface"/>'s own <code>peer</code> option must specify
1100 this <ref table="Interface"/>'s name. That is, the two patch
1101 interfaces must have reversed <ref column="name"/> and
1102 <code>peer</code> values.
1106 <dt><code>null</code></dt>
1107 <dd>An ignored interface.</dd>
1111 <column name="options">
1112 Configuration options whose interpretation varies based on
1113 <ref column="type"/>.
1117 <group title="Interface Status">
1119 Status information about interfaces attached to bridges, updated every
1120 5 seconds. Not all interfaces have all of these properties; virtual
1121 interfaces don't have a link speed, for example. Non-applicable
1122 columns will have empty values.
1124 <column name="admin_state">
1126 The administrative state of the physical network link.
1130 <column name="link_state">
1132 The observed state of the physical network link. This is ordinarily
1133 the link's carrier status. If the interface's <ref table="Port"/> is
1134 a bond configured for miimon monitoring, it is instead the network
1135 link's miimon status.
1139 <column name="link_speed">
1141 The negotiated speed of the physical network link.
1142 Valid values are positive integers greater than 0.
1146 <column name="duplex">
1148 The duplex mode of the physical network link.
1154 The MTU (maximum transmission unit); i.e. the largest
1155 amount of data that can fit into a single Ethernet frame.
1156 The standard Ethernet MTU is 1500 bytes. Some physical media
1157 and many kinds of virtual interfaces can be configured with
1161 This column will be empty for an interface that does not
1162 have an MTU as, for example, some kinds of tunnels do not.
1166 <column name="status">
1168 Key-value pairs that report port status. Supported status
1169 values are <code>type</code>-dependent; some interfaces may not have
1170 a valid <code>driver_name</code>, for example.
1172 <p>The currently defined key-value pairs are:</p>
1174 <dt><code>driver_name</code></dt>
1175 <dd>The name of the device driver controlling the network
1179 <dt><code>driver_version</code></dt>
1180 <dd>The version string of the device driver controlling the
1181 network adapter.</dd>
1184 <dt><code>firmware_version</code></dt>
1185 <dd>The version string of the network adapter's firmware, if
1189 <dt><code>source_ip</code></dt>
1190 <dd>The source IP address used for an IPv4 tunnel end-point,
1191 such as <code>gre</code> or <code>capwap</code>.</dd>
1194 <dt><code>tunnel_egress_iface</code></dt>
1195 <dd>Egress interface for tunnels. Currently only relevant for GRE
1196 and CAPWAP tunnels. On Linux systems, this column will show
1197 the name of the interface which is responsible for routing
1198 traffic destined for the configured <code>remote_ip</code>.
1199 This could be an internal interface such as a bridge port.</dd>
1202 <dt><code>tunnel_egress_iface_carrier</code></dt>
1203 <dd>Whether a carrier is detected on <ref
1204 column="tunnel_egress_iface"/>. Valid values are <code>down</code>
1205 and <code>up</code>.</dd>
1210 <group title="Ingress Policing">
1212 These settings control ingress policing for packets received on this
1213 interface. On a physical interface, this limits the rate at which
1214 traffic is allowed into the system from the outside; on a virtual
1215 interface (one connected to a virtual machine), this limits the rate at
1216 which the VM is able to transmit.
1219 Policing is a simple form of quality-of-service that simply drops
1220 packets received in excess of the configured rate. Due to its
1221 simplicity, policing is usually less accurate and less effective than
1222 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1223 table="Queue"/> tables).
1226 Policing is currently implemented only on Linux. The Linux
1227 implementation uses a simple ``token bucket'' approach:
1231 The size of the bucket corresponds to <ref
1232 column="ingress_policing_burst"/>. Initially the bucket is full.
1235 Whenever a packet is received, its size (converted to tokens) is
1236 compared to the number of tokens currently in the bucket. If the
1237 required number of tokens are available, they are removed and the
1238 packet is forwarded. Otherwise, the packet is dropped.
1241 Whenever it is not full, the bucket is refilled with tokens at the
1242 rate specified by <ref column="ingress_policing_rate"/>.
1246 Policing interacts badly with some network protocols, and especially
1247 with fragmented IP packets. Suppose that there is enough network
1248 activity to keep the bucket nearly empty all the time. Then this token
1249 bucket algorithm will forward a single packet every so often, with the
1250 period depending on packet size and on the configured rate. All of the
1251 fragments of an IP packets are normally transmitted back-to-back, as a
1252 group. In such a situation, therefore, only one of these fragments
1253 will be forwarded and the rest will be dropped. IP does not provide
1254 any way for the intended recipient to ask for only the remaining
1255 fragments. In such a case there are two likely possibilities for what
1256 will happen next: either all of the fragments will eventually be
1257 retransmitted (as TCP will do), in which case the same problem will
1258 recur, or the sender will not realize that its packet has been dropped
1259 and data will simply be lost (as some UDP-based protocols will do).
1260 Either way, it is possible that no forward progress will ever occur.
1262 <column name="ingress_policing_rate">
1264 Maximum rate for data received on this interface, in kbps. Data
1265 received faster than this rate is dropped. Set to <code>0</code>
1266 (the default) to disable policing.
1270 <column name="ingress_policing_burst">
1271 <p>Maximum burst size for data received on this interface, in kb. The
1272 default burst size if set to <code>0</code> is 1000 kb. This value
1273 has no effect if <ref column="ingress_policing_rate"/>
1274 is <code>0</code>.</p>
1276 Specifying a larger burst size lets the algorithm be more forgiving,
1277 which is important for protocols like TCP that react severely to
1278 dropped packets. The burst size should be at least the size of the
1279 interface's MTU. Specifying a value that is numerically at least as
1280 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1281 closer to achieving the full rate.
1286 <group title="Connectivity Fault Management">
1288 802.1ag Connectivity Fault Management (CFM) allows a group of
1289 Maintenance Points (MPs) called a Maintenance Association (MA) to
1290 detect connectivity problems with each other. MPs within a MA should
1291 have complete and exclusive interconnectivity. This is verified by
1292 occasionally broadcasting Continuity Check Messages (CCMs) at a
1293 configurable transmission interval.
1296 <column name="cfm_mpid">
1297 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1298 a Maintenance Association. The MPID is used to identify this endpoint
1299 to other Maintenance Points in the MA. Each end of a link being
1300 monitored should have a different MPID. Must be configured to enable
1301 CFM on this <ref table="Interface"/>.
1304 <column name="cfm_remote_mpid">
1305 The MPID of the remote endpoint being monitored. If this
1306 <ref table="Interface"/> does not have connectivity to an endpoint
1307 advertising the configured MPID, a fault is signalled. Must be
1308 configured to enable CFM on this <ref table="Interface"/>
1311 <column name="cfm_fault">
1312 Indicates a connectivity fault triggered by an inability to receive
1313 heartbeats from the remote endpoint. When a fault is triggered on
1314 <ref table="Interface"/>s participating in bonds, they will be
1319 <group title="Other Features">
1321 <column name="lacp_current">
1322 Boolean value indicating LACP status for this interface. If true, this
1323 interface has current LACP information about its LACP partner. This
1324 information may be used to monitor the health of interfaces in a LACP
1325 enabled port. This column will be empty if LACP is not enabled.
1328 <column name="external_ids">
1329 Key-value pairs for use by external frameworks that integrate
1330 with Open vSwitch, rather than by Open vSwitch itself. System
1331 integrators should either use the Open vSwitch development
1332 mailing list to coordinate on common key-value definitions, or
1333 choose key names that are likely to be unique. The currently
1334 defined common key-value pairs are:
1336 <dt><code>attached-mac</code></dt>
1338 The MAC address programmed into the ``virtual hardware'' for this
1339 interface, in the form
1340 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1341 For Citrix XenServer, this is the value of the <code>MAC</code>
1342 field in the VIF record for this interface.</dd>
1343 <dt><code>iface-id</code></dt>
1344 <dd>A system-unique identifier for the interface. On XenServer,
1345 this will commonly be the same as <code>xs-vif-uuid</code>.</dd>
1348 Additionally the following key-value pairs specifically
1349 apply to an interface that represents a virtual Ethernet interface
1350 connected to a virtual machine. These key-value pairs should not be
1351 present for other types of interfaces. Keys whose names end
1352 in <code>-uuid</code> have values that uniquely identify the entity
1353 in question. For a Citrix XenServer hypervisor, these values are
1354 UUIDs in RFC 4122 format. Other hypervisors may use other
1357 <p>The currently defined key-value pairs for XenServer are:</p>
1359 <dt><code>xs-vif-uuid</code></dt>
1360 <dd>The virtual interface associated with this interface.</dd>
1361 <dt><code>xs-network-uuid</code></dt>
1362 <dd>The virtual network to which this interface is attached.</dd>
1363 <dt><code>xs-vm-uuid</code></dt>
1364 <dd>The VM to which this interface belongs.</dd>
1368 <column name="other_config">
1369 Key-value pairs for rarely used interface features.
1371 <dt><code>cfm_interval</code></dt>
1372 <dd> The transmission interval of CFM heartbeats in milliseconds.
1373 Three missed heartbeat receptions indicate a connectivity fault.
1374 Defaults to 1000ms. </dd>
1375 <dt><code>bond-stable-id</code></dt>
1376 <dd> A positive integer using in <code>stable</code> bond mode to
1377 make slave selection decisions. Allocating
1378 <code>bond-stable-id</code>s consistently across interfaces
1379 participating in a bond will guarantee consistent slave selection
1380 decisions across ovs-vswitchd instances when using
1381 <code>stable</code> bonding mode.</dd>
1382 <dt><code>lacp-port-id</code></dt>
1383 <dd> The LACP port ID of this <ref table="Interface"/>. Port IDs are
1384 used in LACP negotiations to identify individual ports
1385 participating in a bond. Must be a number between 1 and
1387 <dt><code>lacp-port-priority</code></dt>
1388 <dd> The LACP port priority of this <ref table="Interface"/>. In
1389 LACP negotiations <ref table="Interface"/>s with numerically lower
1390 priorities are preferred for aggregation. Must be a number between
1392 <dt><code>lacp-aggregation-key</code></dt>
1393 <dd> The LACP aggregation key of this <ref table="Interface"/>.
1394 <ref table="Interface"/>s with different aggregation keys may not
1395 be active within a given <ref table="Port"/> at the same time. Must
1396 be a number between 1 and 65535.</dd>
1400 <column name="statistics">
1402 Key-value pairs that report interface statistics. The current
1403 implementation updates these counters periodically. In the future,
1404 we plan to, instead, update them when an interface is created, when
1405 they are queried (e.g. using an OVSDB <code>select</code> operation),
1406 and just before an interface is deleted due to virtual interface
1407 hot-unplug or VM shutdown, and perhaps at other times, but not on any
1408 regular periodic basis.</p>
1410 The currently defined key-value pairs are listed below. These are
1411 the same statistics reported by OpenFlow in its <code>struct
1412 ofp_port_stats</code> structure. If an interface does not support a
1413 given statistic, then that pair is omitted.</p>
1416 Successful transmit and receive counters:
1418 <dt><code>rx_packets</code></dt>
1419 <dd>Number of received packets.</dd>
1420 <dt><code>rx_bytes</code></dt>
1421 <dd>Number of received bytes.</dd>
1422 <dt><code>tx_packets</code></dt>
1423 <dd>Number of transmitted packets.</dd>
1424 <dt><code>tx_bytes</code></dt>
1425 <dd>Number of transmitted bytes.</dd>
1431 <dt><code>rx_dropped</code></dt>
1432 <dd>Number of packets dropped by RX.</dd>
1433 <dt><code>rx_frame_err</code></dt>
1434 <dd>Number of frame alignment errors.</dd>
1435 <dt><code>rx_over_err</code></dt>
1436 <dd>Number of packets with RX overrun.</dd>
1437 <dt><code>rx_crc_err</code></dt>
1438 <dd>Number of CRC errors.</dd>
1439 <dt><code>rx_errors</code></dt>
1441 Total number of receive errors, greater than or equal
1442 to the sum of the above.
1449 <dt><code>tx_dropped</code></dt>
1450 <dd>Number of packets dropped by TX.</dd>
1451 <dt><code>collisions</code></dt>
1452 <dd>Number of collisions.</dd>
1453 <dt><code>tx_errors</code></dt>
1455 Total number of transmit errors, greater
1456 than or equal to the sum of the above.
1465 <table name="QoS" title="Quality of Service configuration">
1466 <p>Quality of Service (QoS) configuration for each Port that
1469 <column name="type">
1470 <p>The type of QoS to implement. The <ref table="Open_vSwitch"
1471 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
1472 identifies the types that a switch actually supports. The currently
1473 defined types are listed below:</p>
1475 <dt><code>linux-htb</code></dt>
1477 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
1478 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
1479 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
1480 for information on how this classifier works and how to configure it.
1484 <dt><code>linux-hfsc</code></dt>
1486 Linux "Hierarchical Fair Service Curve" classifier.
1487 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
1488 information on how this classifier works.
1493 <column name="queues">
1494 <p>A map from queue numbers to <ref table="Queue"/> records. The
1495 supported range of queue numbers depend on <ref column="type"/>. The
1496 queue numbers are the same as the <code>queue_id</code> used in
1497 OpenFlow in <code>struct ofp_action_enqueue</code> and other
1498 structures. Queue 0 is used by OpenFlow output actions that do not
1499 specify a specific queue.</p>
1502 <column name="other_config">
1503 <p>Key-value pairs for configuring QoS features that depend on
1504 <ref column="type"/>.</p>
1505 <p>The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
1506 the following key-value pairs:</p>
1508 <dt><code>max-rate</code></dt>
1509 <dd>Maximum rate shared by all queued traffic, in bit/s.
1510 Optional. If not specified, for physical interfaces, the
1511 default is the link rate. For other interfaces or if the
1512 link rate cannot be determined, the default is currently 100
1517 <column name="external_ids">
1518 Key-value pairs for use by external frameworks that integrate with Open
1519 vSwitch, rather than by Open vSwitch itself. System integrators should
1520 either use the Open vSwitch development mailing list to coordinate on
1521 common key-value definitions, or choose key names that are likely to be
1522 unique. No common key-value pairs are currently defined.
1526 <table name="Queue" title="QoS output queue.">
1527 <p>A configuration for a port output queue, used in configuring Quality of
1528 Service (QoS) features. May be referenced by <ref column="queues"
1529 table="QoS"/> column in <ref table="QoS"/> table.</p>
1531 <column name="other_config">
1532 <p>Key-value pairs for configuring the output queue. The supported
1533 key-value pairs and their meanings depend on the <ref column="type"/>
1534 of the <ref column="QoS"/> records that reference this row.</p>
1535 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1536 column="type"/> of <code>min-rate</code> are:</p>
1538 <dt><code>min-rate</code></dt>
1539 <dd>Minimum guaranteed bandwidth, in bit/s. Required. The
1540 floor value is 1500 bytes/s (12,000 bit/s).</dd>
1542 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1543 column="type"/> of <code>linux-htb</code> are:</p>
1545 <dt><code>min-rate</code></dt>
1546 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1547 <dt><code>max-rate</code></dt>
1548 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1549 queue's rate will not be allowed to exceed the specified value, even
1550 if excess bandwidth is available. If unspecified, defaults to no
1552 <dt><code>burst</code></dt>
1553 <dd>Burst size, in bits. This is the maximum amount of ``credits''
1554 that a queue can accumulate while it is idle. Optional. Details of
1555 the <code>linux-htb</code> implementation require a minimum burst
1556 size, so a too-small <code>burst</code> will be silently
1558 <dt><code>priority</code></dt>
1559 <dd>A nonnegative 32-bit integer. Defaults to 0 if
1560 unspecified. A queue with a smaller <code>priority</code>
1561 will receive all the excess bandwidth that it can use before
1562 a queue with a larger value receives any. Specific priority
1563 values are unimportant; only relative ordering matters.</dd>
1565 <p>The key-value pairs defined for <ref table="QoS"/> <ref table="QoS"
1566 column="type"/> of <code>linux-hfsc</code> are:</p>
1568 <dt><code>min-rate</code></dt>
1569 <dd>Minimum guaranteed bandwidth, in bit/s.</dd>
1570 <dt><code>max-rate</code></dt>
1571 <dd>Maximum allowed bandwidth, in bit/s. Optional. If specified, the
1572 queue's rate will not be allowed to exceed the specified value, even
1573 if excess bandwidth is available. If unspecified, defaults to no
1578 <column name="external_ids">
1579 Key-value pairs for use by external frameworks that integrate with Open
1580 vSwitch, rather than by Open vSwitch itself. System integrators should
1581 either use the Open vSwitch development mailing list to coordinate on
1582 common key-value definitions, or choose key names that are likely to be
1583 unique. No common key-value pairs are currently defined.
1587 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
1588 <p>A port mirror within a <ref table="Bridge"/>.</p>
1589 <p>A port mirror configures a bridge to send selected frames to special
1590 ``mirrored'' ports, in addition to their normal destinations. Mirroring
1591 traffic may also be referred to as SPAN or RSPAN, depending on the
1592 mechanism used for delivery.</p>
1594 <column name="name">
1595 Arbitrary identifier for the <ref table="Mirror"/>.
1598 <group title="Selecting Packets for Mirroring">
1600 To be selected for mirroring, a given packet must enter or leave the
1601 bridge through a selected port and it must also be in one of the
1605 <column name="select_all">
1606 If true, every packet arriving or departing on any port is
1607 selected for mirroring.
1610 <column name="select_dst_port">
1611 Ports on which departing packets are selected for mirroring.
1614 <column name="select_src_port">
1615 Ports on which arriving packets are selected for mirroring.
1618 <column name="select_vlan">
1619 VLANs on which packets are selected for mirroring. An empty set
1620 selects packets on all VLANs.
1624 <group title="Mirroring Destination Configuration">
1626 These columns are mutually exclusive. Exactly one of them must be
1630 <column name="output_port">
1631 <p>Output port for selected packets, if nonempty.</p>
1632 <p>Specifying a port for mirror output reserves that port exclusively
1633 for mirroring. No frames other than those selected for mirroring
1634 will be forwarded to the port, and any frames received on the port
1635 will be discarded.</p>
1636 <p>This type of mirroring is sometimes called SPAN.</p>
1639 <column name="output_vlan">
1640 <p>Output VLAN for selected packets, if nonempty.</p>
1641 <p>The frames will be sent out all ports that trunk
1642 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
1643 <ref column="output_vlan"/>. When a mirrored frame is sent out a
1644 trunk port, the frame's VLAN tag will be set to
1645 <ref column="output_vlan"/>, replacing any existing tag; when it is
1646 sent out an implicit VLAN port, the frame will not be tagged. This
1647 type of mirroring is sometimes called RSPAN.</p>
1648 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
1649 contains unmanaged switches. Consider an unmanaged physical switch
1650 with two ports: port 1, connected to an end host, and port 2,
1651 connected to an Open vSwitch configured to mirror received packets
1652 into VLAN 123 on port 2. Suppose that the end host sends a packet on
1653 port 1 that the physical switch forwards to port 2. The Open vSwitch
1654 forwards this packet to its destination and then reflects it back on
1655 port 2 in VLAN 123. This reflected packet causes the unmanaged
1656 physical switch to replace the MAC learning table entry, which
1657 correctly pointed to port 1, with one that incorrectly points to port
1658 2. Afterward, the physical switch will direct packets destined for
1659 the end host to the Open vSwitch on port 2, instead of to the end
1660 host on port 1, disrupting connectivity. If mirroring to a VLAN is
1661 desired in this scenario, then the physical switch must be replaced
1662 by one that learns Ethernet addresses on a per-VLAN basis. In
1663 addition, learning should be disabled on the VLAN containing mirrored
1664 traffic. If this is not done then intermediate switches will learn
1665 the MAC address of each end host from the mirrored traffic. If
1666 packets being sent to that end host are also mirrored, then they will
1667 be dropped since the switch will attempt to send them out the input
1668 port. Disabling learning for the VLAN will cause the switch to
1669 correctly send the packet out all ports configured for that VLAN. If
1670 Open vSwitch is being used as an intermediate switch, learning can be
1671 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
1672 in the appropriate <ref table="Bridge"/> table or tables.</p>
1676 <group title="Other Features">
1677 <column name="external_ids">
1678 Key-value pairs for use by external frameworks that integrate with Open
1679 vSwitch, rather than by Open vSwitch itself. System integrators should
1680 either use the Open vSwitch development mailing list to coordinate on
1681 common key-value definitions, or choose key names that are likely to be
1682 unique. No common key-value pairs are currently defined.
1687 <table name="Controller" title="OpenFlow controller configuration.">
1688 <p>An OpenFlow controller.</p>
1691 Open vSwitch supports two kinds of OpenFlow controllers:
1695 <dt>Primary controllers</dt>
1698 This is the kind of controller envisioned by the OpenFlow 1.0
1699 specification. Usually, a primary controller implements a network
1700 policy by taking charge of the switch's flow table.
1704 Open vSwitch initiates and maintains persistent connections to
1705 primary controllers, retrying the connection each time it fails or
1706 drops. The <ref table="Bridge" column="fail_mode"/> column in the
1707 <ref table="Bridge"/> table applies to primary controllers.
1711 Open vSwitch permits a bridge to have any number of primary
1712 controllers. When multiple controllers are configured, Open
1713 vSwitch connects to all of them simultaneously. Because
1714 OpenFlow 1.0 does not specify how multiple controllers
1715 coordinate in interacting with a single switch, more than
1716 one primary controller should be specified only if the
1717 controllers are themselves designed to coordinate with each
1718 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
1719 vendor extension may be useful for this.)
1722 <dt>Service controllers</dt>
1725 These kinds of OpenFlow controller connections are intended for
1726 occasional support and maintenance use, e.g. with
1727 <code>ovs-ofctl</code>. Usually a service controller connects only
1728 briefly to inspect or modify some of a switch's state.
1732 Open vSwitch listens for incoming connections from service
1733 controllers. The service controllers initiate and, if necessary,
1734 maintain the connections from their end. The <ref table="Bridge"
1735 column="fail_mode"/> column in the <ref table="Bridge"/> table does
1736 not apply to service controllers.
1740 Open vSwitch supports configuring any number of service controllers.
1746 The <ref column="target"/> determines the type of controller.
1749 <group title="Core Features">
1750 <column name="target">
1751 <p>Connection method for controller.</p>
1753 The following connection methods are currently supported for primary
1757 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1759 <p>The specified SSL <var>port</var> (default: 6633) on the host at
1760 the given <var>ip</var>, which must be expressed as an IP address
1761 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
1762 column in the <ref table="Open_vSwitch"/> table must point to a
1763 valid SSL configuration when this form is used.</p>
1764 <p>SSL support is an optional feature that is not always built as
1765 part of Open vSwitch.</p>
1767 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
1768 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
1769 the given <var>ip</var>, which must be expressed as an IP address
1770 (not a DNS name).</dd>
1773 The following connection methods are currently supported for service
1777 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1780 Listens for SSL connections on the specified TCP <var>port</var>
1781 (default: 6633). If <var>ip</var>, which must be expressed as an
1782 IP address (not a DNS name), is specified, then connections are
1783 restricted to the specified local IP address.
1786 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
1787 table="Open_vSwitch"/> table must point to a valid SSL
1788 configuration when this form is used.
1790 <p>SSL support is an optional feature that is not always built as
1791 part of Open vSwitch.</p>
1793 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
1795 Listens for connections on the specified TCP <var>port</var>
1796 (default: 6633). If <var>ip</var>, which must be expressed as an
1797 IP address (not a DNS name), is specified, then connections are
1798 restricted to the specified local IP address.
1801 <p>When multiple controllers are configured for a single bridge, the
1802 <ref column="target"/> values must be unique. Duplicate
1803 <ref column="target"/> values yield unspecified results.</p>
1806 <column name="connection_mode">
1807 <p>If it is specified, this setting must be one of the following
1808 strings that describes how Open vSwitch contacts this OpenFlow
1809 controller over the network:</p>
1812 <dt><code>in-band</code></dt>
1813 <dd>In this mode, this controller's OpenFlow traffic travels over the
1814 bridge associated with the controller. With this setting, Open
1815 vSwitch allows traffic to and from the controller regardless of the
1816 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
1817 would never be able to connect to the controller, because it did
1818 not have a flow to enable it.) This is the most common connection
1819 mode because it is not necessary to maintain two independent
1821 <dt><code>out-of-band</code></dt>
1822 <dd>In this mode, OpenFlow traffic uses a control network separate
1823 from the bridge associated with this controller, that is, the
1824 bridge does not use any of its own network devices to communicate
1825 with the controller. The control network must be configured
1826 separately, before or after <code>ovs-vswitchd</code> is started.
1830 <p>If not specified, the default is implementation-specific.</p>
1834 <group title="Controller Failure Detection and Handling">
1835 <column name="max_backoff">
1836 Maximum number of milliseconds to wait between connection attempts.
1837 Default is implementation-specific.
1840 <column name="inactivity_probe">
1841 Maximum number of milliseconds of idle time on connection to
1842 controller before sending an inactivity probe message. If Open
1843 vSwitch does not communicate with the controller for the specified
1844 number of seconds, it will send a probe. If a response is not
1845 received for the same additional amount of time, Open vSwitch
1846 assumes the connection has been broken and attempts to reconnect.
1847 Default is implementation-specific. A value of 0 disables
1852 <group title="OpenFlow Rate Limiting">
1853 <column name="controller_rate_limit">
1854 <p>The maximum rate at which packets in unknown flows will be
1855 forwarded to the OpenFlow controller, in packets per second. This
1856 feature prevents a single bridge from overwhelming the controller.
1857 If not specified, the default is implementation-specific.</p>
1858 <p>In addition, when a high rate triggers rate-limiting, Open
1859 vSwitch queues controller packets for each port and transmits
1860 them to the controller at the configured rate. The number of
1861 queued packets is limited by
1862 the <ref column="controller_burst_limit"/> value. The packet
1863 queue is shared fairly among the ports on a bridge.</p><p>Open
1864 vSwitch maintains two such packet rate-limiters per bridge.
1865 One of these applies to packets sent up to the controller
1866 because they do not correspond to any flow. The other applies
1867 to packets sent up to the controller by request through flow
1868 actions. When both rate-limiters are filled with packets, the
1869 actual rate that packets are sent to the controller is up to
1870 twice the specified rate.</p>
1873 <column name="controller_burst_limit">
1874 In conjunction with <ref column="controller_rate_limit"/>,
1875 the maximum number of unused packet credits that the bridge will
1876 allow to accumulate, in packets. If not specified, the default
1877 is implementation-specific.
1881 <group title="Additional In-Band Configuration">
1882 <p>These values are considered only in in-band control mode (see
1883 <ref column="connection_mode"/>).</p>
1885 <p>When multiple controllers are configured on a single bridge, there
1886 should be only one set of unique values in these columns. If different
1887 values are set for these columns in different controllers, the effect
1890 <column name="local_ip">
1891 The IP address to configure on the local port,
1892 e.g. <code>192.168.0.123</code>. If this value is unset, then
1893 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
1897 <column name="local_netmask">
1898 The IP netmask to configure on the local port,
1899 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
1900 but this value is unset, then the default is chosen based on whether
1901 the IP address is class A, B, or C.
1904 <column name="local_gateway">
1905 The IP address of the gateway to configure on the local port, as a
1906 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
1907 this network has no gateway.
1911 <group title="Other Features">
1912 <column name="external_ids">
1913 Key-value pairs for use by external frameworks that integrate with Open
1914 vSwitch, rather than by Open vSwitch itself. System integrators should
1915 either use the Open vSwitch development mailing list to coordinate on
1916 common key-value definitions, or choose key names that are likely to be
1917 unique. No common key-value pairs are currently defined.
1921 <group title="Controller Status">
1922 <column name="is_connected">
1923 <code>true</code> if currently connected to this controller,
1924 <code>false</code> otherwise.
1927 <column name="role">
1928 <p>The level of authority this controller has on the associated
1929 bridge. Possible values are:</p>
1931 <dt><code>other</code></dt>
1932 <dd>Allows the controller access to all OpenFlow features.</dd>
1933 <dt><code>master</code></dt>
1934 <dd>Equivalent to <code>other</code>, except that there may be at
1935 most one master controller at a time. When a controller configures
1936 itself as <code>master</code>, any existing master is demoted to
1937 the <code>slave</code>role.</dd>
1938 <dt><code>slave</code></dt>
1939 <dd>Allows the controller read-only access to OpenFlow features.
1940 Attempts to modify the flow table will be rejected with an
1941 error. Slave controllers do not receive OFPT_PACKET_IN or
1942 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
1947 <column name="status">
1948 <p>Key-value pairs that report controller status.</p>
1950 <dt><code>last_error</code></dt>
1951 <dd>A human-readable description of the last error on the connection
1952 to the controller; i.e. <code>strerror(errno)</code>. This key
1953 will exist only if an error has occurred.</dd>
1954 <dt><code>state</code></dt>
1955 <dd>The state of the connection to the controller. Possible values
1956 are: <code>VOID</code> (connection is disabled),
1957 <code>BACKOFF</code> (attempting to reconnect at an increasing
1958 period), <code>CONNECTING</code> (attempting to connect),
1959 <code>ACTIVE</code> (connected, remote host responsive), and
1960 <code>IDLE</code> (remote host idle, sending keep-alive). These
1961 values may change in the future. They are provided only for human
1963 <dt><code>sec_since_connect</code></dt>
1964 <dd>The amount of time since this controller last successfully
1965 connected to the switch (in seconds). Value is empty if controller
1966 has never successfully connected.</dd>
1967 <dt><code>sec_since_disconnect</code></dt>
1968 <dd>The amount of time since this controller last disconnected from
1969 the switch (in seconds). Value is empty if controller has never
1976 <table name="Manager" title="OVSDB management connection.">
1978 Configuration for a database connection to an Open vSwitch database
1983 This table primarily configures the Open vSwitch database
1984 (<code>ovsdb-server</code>), not the Open vSwitch switch
1985 (<code>ovs-vswitchd</code>). The switch does read the table to determine
1986 what connections should be treated as in-band.
1990 The Open vSwitch database server can initiate and maintain active
1991 connections to remote clients. It can also listen for database
1995 <group title="Core Features">
1996 <column name="target">
1997 <p>Connection method for managers.</p>
1999 The following connection methods are currently supported:
2002 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2005 The specified SSL <var>port</var> (default: 6632) on the host at
2006 the given <var>ip</var>, which must be expressed as an IP address
2007 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2008 column in the <ref table="Open_vSwitch"/> table must point to a
2009 valid SSL configuration when this form is used.
2012 SSL support is an optional feature that is not always built as
2013 part of Open vSwitch.
2017 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2019 The specified TCP <var>port</var> (default: 6632) on the host at
2020 the given <var>ip</var>, which must be expressed as an IP address
2023 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2026 Listens for SSL connections on the specified TCP <var>port</var>
2027 (default: 6632). If <var>ip</var>, which must be expressed as an
2028 IP address (not a DNS name), is specified, then connections are
2029 restricted to the specified local IP address.
2032 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2033 table="Open_vSwitch"/> table must point to a valid SSL
2034 configuration when this form is used.
2037 SSL support is an optional feature that is not always built as
2038 part of Open vSwitch.
2041 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2043 Listens for connections on the specified TCP <var>port</var>
2044 (default: 6632). If <var>ip</var>, which must be expressed as an
2045 IP address (not a DNS name), is specified, then connections are
2046 restricted to the specified local IP address.
2049 <p>When multiple managers are configured, the <ref column="target"/>
2050 values must be unique. Duplicate <ref column="target"/> values yield
2051 unspecified results.</p>
2054 <column name="connection_mode">
2056 If it is specified, this setting must be one of the following strings
2057 that describes how Open vSwitch contacts this OVSDB client over the
2062 <dt><code>in-band</code></dt>
2064 In this mode, this connection's traffic travels over a bridge
2065 managed by Open vSwitch. With this setting, Open vSwitch allows
2066 traffic to and from the client regardless of the contents of the
2067 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2068 to connect to the client, because it did not have a flow to enable
2069 it.) This is the most common connection mode because it is not
2070 necessary to maintain two independent networks.
2072 <dt><code>out-of-band</code></dt>
2074 In this mode, the client's traffic uses a control network separate
2075 from that managed by Open vSwitch, that is, Open vSwitch does not
2076 use any of its own network devices to communicate with the client.
2077 The control network must be configured separately, before or after
2078 <code>ovs-vswitchd</code> is started.
2083 If not specified, the default is implementation-specific.
2088 <group title="Client Failure Detection and Handling">
2089 <column name="max_backoff">
2090 Maximum number of milliseconds to wait between connection attempts.
2091 Default is implementation-specific.
2094 <column name="inactivity_probe">
2095 Maximum number of milliseconds of idle time on connection to the client
2096 before sending an inactivity probe message. If Open vSwitch does not
2097 communicate with the client for the specified number of seconds, it
2098 will send a probe. If a response is not received for the same
2099 additional amount of time, Open vSwitch assumes the connection has been
2100 broken and attempts to reconnect. Default is implementation-specific.
2101 A value of 0 disables inactivity probes.
2105 <group title="Other Features">
2106 <column name="external_ids">
2107 Key-value pairs for use by external frameworks that integrate with Open
2108 vSwitch, rather than by Open vSwitch itself. System integrators should
2109 either use the Open vSwitch development mailing list to coordinate on
2110 common key-value definitions, or choose key names that are likely to be
2111 unique. No common key-value pairs are currently defined.
2115 <group title="Status">
2116 <column name="is_connected">
2117 <code>true</code> if currently connected to this manager,
2118 <code>false</code> otherwise.
2121 <column name="status">
2122 <p>Key-value pairs that report manager status.</p>
2124 <dt><code>last_error</code></dt>
2125 <dd>A human-readable description of the last error on the connection
2126 to the manager; i.e. <code>strerror(errno)</code>. This key
2127 will exist only if an error has occurred.</dd>
2130 <dt><code>state</code></dt>
2131 <dd>The state of the connection to the manager. Possible values
2132 are: <code>VOID</code> (connection is disabled),
2133 <code>BACKOFF</code> (attempting to reconnect at an increasing
2134 period), <code>CONNECTING</code> (attempting to connect),
2135 <code>ACTIVE</code> (connected, remote host responsive), and
2136 <code>IDLE</code> (remote host idle, sending keep-alive). These
2137 values may change in the future. They are provided only for human
2141 <dt><code>sec_since_connect</code></dt>
2142 <dd>The amount of time since this manager last successfully connected
2143 to the database (in seconds). Value is empty if manager has never
2144 successfully connected.</dd>
2147 <dt><code>sec_since_disconnect</code></dt>
2148 <dd>The amount of time since this manager last disconnected from the
2149 database (in seconds). Value is empty if manager has never
2156 <table name="NetFlow">
2157 A NetFlow target. NetFlow is a protocol that exports a number of
2158 details about terminating IP flows, such as the principals involved
2161 <column name="targets">
2162 NetFlow targets in the form
2163 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
2164 must be specified numerically, not as a DNS name.
2167 <column name="engine_id">
2168 Engine ID to use in NetFlow messages. Defaults to datapath index
2172 <column name="engine_type">
2173 Engine type to use in NetFlow messages. Defaults to datapath
2174 index if not specified.
2177 <column name="active_timeout">
2178 The interval at which NetFlow records are sent for flows that are
2179 still active, in seconds. A value of <code>0</code> requests the
2180 default timeout (currently 600 seconds); a value of <code>-1</code>
2181 disables active timeouts.
2184 <column name="add_id_to_interface">
2185 <p>If this column's value is <code>false</code>, the ingress and egress
2186 interface fields of NetFlow flow records are derived from OpenFlow port
2187 numbers. When it is <code>true</code>, the 7 most significant bits of
2188 these fields will be replaced by the least significant 7 bits of the
2189 engine id. This is useful because many NetFlow collectors do not
2190 expect multiple switches to be sending messages from the same host, so
2191 they do not store the engine information which could be used to
2192 disambiguate the traffic.</p>
2193 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
2196 <column name="external_ids">
2197 Key-value pairs for use by external frameworks that integrate with Open
2198 vSwitch, rather than by Open vSwitch itself. System integrators should
2199 either use the Open vSwitch development mailing list to coordinate on
2200 common key-value definitions, or choose key names that are likely to be
2201 unique. No common key-value pairs are currently defined.
2206 SSL configuration for an Open_vSwitch.
2208 <column name="private_key">
2209 Name of a PEM file containing the private key used as the switch's
2210 identity for SSL connections to the controller.
2213 <column name="certificate">
2214 Name of a PEM file containing a certificate, signed by the
2215 certificate authority (CA) used by the controller and manager,
2216 that certifies the switch's private key, identifying a trustworthy
2220 <column name="ca_cert">
2221 Name of a PEM file containing the CA certificate used to verify
2222 that the switch is connected to a trustworthy controller.
2225 <column name="bootstrap_ca_cert">
2226 If set to <code>true</code>, then Open vSwitch will attempt to
2227 obtain the CA certificate from the controller on its first SSL
2228 connection and save it to the named PEM file. If it is successful,
2229 it will immediately drop the connection and reconnect, and from then
2230 on all SSL connections must be authenticated by a certificate signed
2231 by the CA certificate thus obtained. <em>This option exposes the
2232 SSL connection to a man-in-the-middle attack obtaining the initial
2233 CA certificate.</em> It may still be useful for bootstrapping.
2236 <column name="external_ids">
2237 Key-value pairs for use by external frameworks that integrate with Open
2238 vSwitch, rather than by Open vSwitch itself. System integrators should
2239 either use the Open vSwitch development mailing list to coordinate on
2240 common key-value definitions, or choose key names that are likely to be
2241 unique. No common key-value pairs are currently defined.
2245 <table name="sFlow">
2246 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
2249 <column name="agent">
2250 Name of the network device whose IP address should be reported as the
2251 ``agent address'' to collectors. If not specified, the IP address
2252 defaults to the <ref table="Controller" column="local_ip"/> in the
2253 collector's <ref table="Controller"/>. If an agent IP address cannot be
2254 determined either way, sFlow is disabled.
2257 <column name="header">
2258 Number of bytes of a sampled packet to send to the collector.
2259 If not specified, the default is 128 bytes.
2262 <column name="polling">
2263 Polling rate in seconds to send port statistics to the collector.
2264 If not specified, defaults to 30 seconds.
2267 <column name="sampling">
2268 Rate at which packets should be sampled and sent to the collector.
2269 If not specified, defaults to 400, which means one out of 400
2270 packets, on average, will be sent to the collector.
2273 <column name="targets">
2274 sFlow targets in the form
2275 <code><var>ip</var>:<var>port</var></code>.
2278 <column name="external_ids">
2279 Key-value pairs for use by external frameworks that integrate with Open
2280 vSwitch, rather than by Open vSwitch itself. System integrators should
2281 either use the Open vSwitch development mailing list to coordinate on
2282 common key-value definitions, or choose key names that are likely to be
2283 unique. No common key-value pairs are currently defined.
2287 <table name="Capability">
2288 <p>Records in this table describe functionality supported by the hardware
2289 and software platform on which this Open vSwitch is based. Clients
2290 should not modify this table.</p>
2292 <p>A record in this table is meaningful only if it is referenced by the
2293 <ref table="Open_vSwitch" column="capabilities"/> column in the
2294 <ref table="Open_vSwitch"/> table. The key used to reference it, called
2295 the record's ``category,'' determines the meanings of the
2296 <ref column="details"/> column. The following general forms of
2297 categories are currently defined:</p>
2300 <dt><code>qos-<var>type</var></code></dt>
2301 <dd><var>type</var> is supported as the value for
2302 <ref column="type" table="QoS"/> in the <ref table="QoS"/> table.
2306 <column name="details">
2307 <p>Key-value pairs that describe capabilities. The meaning of the pairs
2308 depends on the category key that the <ref table="Open_vSwitch"
2309 column="capabilities"/> column in the <ref table="Open_vSwitch"/> table
2310 uses to reference this record, as described above.</p>
2312 <p>The presence of a record for category <code>qos-<var>type</var></code>
2313 indicates that the switch supports <var>type</var> as the value of
2314 the <ref table="QoS" column="type"/> column in the <ref table="QoS"/>
2315 table. The following key-value pairs are defined to further describe
2316 QoS capabilities:</p>
2319 <dt><code>n-queues</code></dt>
2320 <dd>Number of supported queues, as a positive integer. Keys in the
2321 <ref table="QoS" column="queues"/> column for <ref table="QoS"/>
2322 records whose <ref table="QoS" column="type"/> value
2323 equals <var>type</var> must range between 0 and this value minus one,
git://git.onelab.eu / sliver-openvswitch.git / blob