1 <database title="Open vSwitch Configuration Database">
2 <p>A database with this schema holds the configuration for one Open
3 vSwitch daemon. The root of the configuration for the daemon is
4 the <ref table="Open_vSwitch"/> table, which must have exactly one
5 record. Records in other tables are significant only when they
6 can be reached directly or indirectly from the
7 <ref table="Open_vSwitch"/> table.</p>
9 <table name="Open_vSwitch" title="Open vSwitch configuration.">
10 Configuration for an Open vSwitch daemon. There must be exactly one record
11 in the <ref table="Open_vSwitch"/> table.
13 <group title="Configuration">
14 <column name="bridges">
15 Set of bridges managed by the daemon.
18 <column name="controller">
19 Default <ref table="Controller"/> used by bridges. May be
20 overridden on a per-bridge basis by the <ref table="Bridge"
21 column="controller"/> column in <ref table="Bridge"/>.
24 <column name="managers">
25 Remote database clients to which the Open vSwitch's database server
26 should connect or to which it should listen.
30 SSL used globally by the daemon.
33 <column name="external_ids">
34 Key-value pairs that identify this Open vSwitch's role in
35 external systems. The currently defined key-value pairs are:
37 <dt><code>system-uuid</code></dt>
38 <dd>A universally unique identifier for the Open vSwitch's
39 physical host. The form of the identifier depends on the
40 type of the host. On a Citrix XenServer, this is the host
41 UUID displayed by, e.g., <code>xe host-list</code>.</dd>
46 <group title="Status">
47 <column name="next_cfg">
48 Sequence number for client to increment. When a client modifies
49 any part of the database configuration and wishes to wait for
50 Open vSwitch to finish applying the changes, it may increment
54 <column name="cur_cfg">
55 Sequence number that Open vSwitch sets to the current value of
56 <ref column="next_cfg"/> after it finishes applying a set of
57 configuration changes.
64 Configuration for a bridge within an
65 <ref table="Open_vSwitch"/>.
68 A <ref table="Bridge"/> record represents an Ethernet switch with one or
69 more ``ports,'' which are the <ref table="Port"/> records pointed to by
70 the <ref table="Bridge"/>'s <ref column="ports"/> column.
73 <group title="Core Features">
75 Bridge identifier. Should be alphanumeric and no more than about 8
76 bytes long. Must be unique among the names of ports, interfaces, and
81 Ports included in the bridge.
84 <column name="mirrors">
85 Port mirroring configuration.
88 <column name="netflow">
89 NetFlow configuration.
96 <column name="flood_vlans">
97 VLAN IDs of VLANs on which MAC address learning should be disabled, so
98 that packets are flooded instead of being sent to specific ports that
99 are believed to contain packets' destination MACs. This should
100 ordinarily be used to disable MAC learning on VLANs used for mirroring
101 (RSPAN VLANs). It may also be useful for debugging.
105 <group title="OpenFlow Configuration">
106 <column name="controller">
107 OpenFlow controller. If unset, defaults to that specified by
108 <ref column="controller" table="Open_vSwitch"/> in the
109 <ref table="Open_vSwitch"/> table. If the default is also unset, then
110 no OpenFlow controller will be used.
113 <column name="datapath_id">
114 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
118 <group title="Other Features">
119 <column name="datapath_type">
120 Name of datapath provider. The kernel datapath has
121 type <code>system</code>. The userspace datapath has
122 type <code>netdev</code>.
125 <column name="external_ids">
126 Key-value pairs that identify this bridge's role in external systems.
127 The currently defined key-value pairs are:
129 <dt><code>network-uuids</code></dt>
130 <dd>Semicolon-delimited set of universally unique identifier(s) for
131 the network with which this bridge is associated. The form of the
132 identifier(s) depends on the type of the host. On a Citrix
133 XenServer host, the network identifiers are RFC 4122 UUIDs as
134 displayed by, e.g., <code>xe network-list</code>.</dd>
138 <column name="other_config">
139 Key-value pairs for configuring rarely used bridge
140 features. The currently defined key-value pairs are:
142 <dt><code>datapath-id</code></dt>
144 digits to set the OpenFlow datapath ID to a specific
146 <dt><code>hwaddr</code></dt>
147 <dd>An Ethernet address in the form
148 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
149 to set the hardware address of the local port and influence the
156 <table name="Port" table="Port or bond configuration.">
157 <p>A port within a <ref table="Bridge"/>.</p>
158 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
159 <ref column="interfaces"/> column. Such a port logically
160 corresponds to a port on a physical Ethernet switch. A port
161 with more than one interface is a ``bonded port'' (see
162 <ref group="Bonding Configuration"/>).</p>
163 <p>Some properties that one might think as belonging to a port are actually
164 part of the port's <ref table="Interface"/> members.</p>
167 Port name. Should be alphanumeric and no more than about 8
168 bytes long. May be the same as the interface name, for
169 non-bonded ports. Must otherwise be unique among the names of
170 ports, interfaces, and bridges on a host.
173 <column name="interfaces">
174 The port's interfaces. If there is more than one, this is a
178 <group title="VLAN Configuration">
179 <p>A bridge port must be configured for VLANs in one of two
180 mutually exclusive ways:
182 <li>A ``trunk port'' has an empty value for
183 <ref column="tag"/> and a possibly non-empty
184 <ref column="trunks"/> value.</li>
185 <li>An ``implicitly tagged VLAN port'' or ``access port''
186 has an nonempty value for <ref column="tag"/> and an empty
187 <ref column="trunks"/> value.</li>
189 If <ref column="trunks"/> and <ref column="tag"/> are both
190 nonempty, the configuration is ill-formed.
194 <p>If nonempty, this port's implicitly tagged VLAN. Frames
195 arriving on trunk ports will be forwarded to this port only
196 if they are tagged with the given VLAN. Frames arriving on
197 other VLAN ports will be forwarded to this port only if they
198 have the same <ref column="tag"/> value. Frames forwarded
199 to this port will not have an 802.1Q header.</p>
200 <p>When a frame with a 802.1Q header that indicates a nonzero VLAN is
201 received on an implicit VLAN port, it is discarded.</p>
202 <p>Must be empty if this is a trunk port.</p>
205 <column name="trunks">
206 <p>The 802.1Q VLAN(s) that this port trunks. If the column is
207 empty, then the port trunks all VLANs as well as packets that
208 have no VLAN header. Otherwise, only frames that have an
209 802.1Q header with one of the specified VLANs are accepted.
210 If <code>0</code> is included, then frames without an 802.1Q
211 header are also accepted.</p>
212 <p>Must be empty unless this is a trunk port.</p>
216 <group title="Bonding Configuration">
217 <p>A port that has more than one interface is a ``bonded port.''
218 Bonding allows for load balancing and fail-over. Open vSwitch
219 supports ``source load balancing'' (SLB) bonding, which
220 assigns flows to slaves based on source MAC address, with
221 periodic rebalancing as traffic patterns change. This form of
222 bonding does not require 802.3ad or other special support from
223 the upstream switch to which the slave devices are
226 <p>These columns apply only to bonded ports. Their values are
227 otherwise ignored.</p>
229 <column name="bond_updelay">
230 <p>For a bonded port, the number of milliseconds for which carrier must
231 stay up on an interface before the interface is considered to be up.
232 Specify <code>0</code> to enable the interface immediately.</p>
233 <p>This setting is honored only when at least one bonded interface is
234 already enabled. When no interfaces are enabled, then the first bond
235 interface to come up is enabled immediately.</p>
238 <column name="bond_downdelay">
239 For a bonded port, the number of milliseconds for which carrier must
240 stay down on an interface before the interface is considered to be
241 down. Specify <code>0</code> to disable the interface immediately.
244 <column name="bond_fake_iface">
245 For a bonded port, whether to create a fake internal interface with the
246 name of the port. Use only for compatibility with legacy software that
251 <group title="Other Features">
253 The MAC address to use for this port for the purpose of choosing the
254 bridge's MAC address. This column does not necessarily reflect the
255 port's actual MAC address, nor will setting it change the port's actual
259 <column name="fake_bridge">
260 Does this port represent a sub-bridge for its tagged VLAN within the
261 Bridge? See ovs-vsctl(8) for more information.
264 <column name="external_ids">
265 Key-value pairs that identify this port's role in external systems. No
266 key-value pairs native to <ref table="Port"/> are currently defined.
267 For fake bridges (see the <ref column="fake_bridge"/> column), external
268 IDs for the fake bridge are defined here by prefixing a
269 <ref table="Bridge"/> <ref table="Bridge" column="external_ids"/> key
270 with <code>fake-bridge-</code>,
271 e.g. <code>fake-bridge-network-uuids</code>.
274 <column name="other_config">
275 Key-value pairs for configuring rarely used port features. The
276 currently defined key-value pairs are:
278 <dt><code>hwaddr</code></dt>
279 <dd>An Ethernet address in the form
280 <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
281 <dt><code>bond-rebalance-interval</code></dt>
282 <dd>For a bonded port, the number of milliseconds between
283 successive attempts to rebalance the bond, that is, to
284 move source MACs and their flows from one interface on
285 the bond to another in an attempt to keep usage of each
286 interface roughly equal. The default is 10000 (10
287 seconds), and the minimum is 1000 (1 second).</dd>
293 <table name="Interface" title="One physical network device in a Port.">
294 An interface within a <ref table="Port"/>.
296 <group title="Core Features">
298 Interface name. Should be alphanumeric and no more than about 8 bytes
299 long. May be the same as the port name, for non-bonded ports. Must
300 otherwise be unique among the names of ports, interfaces, and bridges
305 <p>Ethernet address to set for this interface. If unset then the
306 default MAC address is used:</p>
308 <li>For the local interface, the default is the lowest-numbered MAC
309 address among the other bridge ports, either the value of the
310 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
311 if set, or its actual MAC (for bonded ports, the MAC of its slave
312 whose name is first in alphabetical order). Internal ports and
313 bridge ports that are used as port mirroring destinations (see the
314 <ref table="Mirror"/> table) are ignored.</li>
315 <li>For other internal interfaces, the default MAC is randomly
317 <li>External interfaces typically have a MAC address associated with
320 <p>Some interfaces may not have a software-controllable MAC
324 <column name="ofport">
325 <p>OpenFlow port number for this interface. Unlike most columns, this
326 column's value should be set only by Open vSwitch itself. Other
327 clients should set this column to an empty set (the default) when
328 creating an <ref table="Interface"/>.</p>
329 <p>Open vSwitch populates this column when the port number becomes
330 known. If the interface is successfully added,
331 <ref column="ofport"/> will be set to a number between 1 and 65535
332 (generally either in the range 1 to 65280, exclusive, or 65534, the
333 port number for the OpenFlow ``local port''). If the interface
334 cannot be added then Open vSwitch sets this column
339 <group title="System-Specific Details">
341 The interface type, one of:
343 <dt><code>system</code></dt>
344 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
345 Sometimes referred to as ``external interfaces'' since they are
346 generally connected to hardware external to that on which the Open
347 vSwitch is running. The empty string is a synonym for
348 <code>system</code>.</dd>
349 <dt><code>internal</code></dt>
350 <dd>A simulated network device that sends and receives traffic. An
351 internal interface whose <ref column="name"/> is the same as its
352 bridge's <ref table="Open_vSwitch" column="name"/> is called the
353 ``local interface.'' It does not make sense to bond an internal
354 interface, so the terms ``port'' and ``interface'' are often used
355 imprecisely for internal interfaces.</dd>
356 <dt><code>tap</code></dt>
357 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
358 <dt><code>gre</code></dt>
359 <dd>An Ethernet over RFC 1702 Generic Routing Encapsulation over IPv4
360 tunnel. Each tunnel must be uniquely identified by the
361 combination of <code>remote_ip</code>, <code>local_ip</code>, and
362 <code>in_key</code>. Note that if two ports are defined that are
363 the same except one has an optional identifier and the other does
364 not, the more specific one is matched first. <code>in_key</code>
365 is considered more specific than <code>local_ip</code> if a port
366 defines one and another port defines the other. The arguments
369 <dt><code>remote_ip</code></dt>
370 <dd>Required. The tunnel endpoint.</dd>
373 <dt><code>local_ip</code></dt>
374 <dd>Optional. The destination IP that received packets must
375 match. Default is to match all addresses.</dd>
378 <dt><code>in_key</code></dt>
379 <dd>Optional. The GRE key that received packets must contain.
380 It may either be a 32-bit number (no key and a key of 0 are
381 treated as equivalent) or the word <code>flow</code>. If
382 <code>flow</code> is specified then any key will be accepted
383 and the key will be placed in the <code>tun_id</code> field
384 for matching in the flow table. The ovs-ofctl manual page
385 contains additional information about matching fields in
386 OpenFlow flows. Default is no key.</dd>
389 <dt><code>out_key</code></dt>
390 <dd>Optional. The GRE key to be set on outgoing packets. It may
391 either be a 32-bit number or the word <code>flow</code>. If
392 <code>flow</code> is specified then the key may be set using
393 the <code>set_tunnel</code> Nicira OpenFlow vendor extension (0
394 is used in the absense of an action). The ovs-ofctl manual
395 page contains additional information about the Nicira OpenFlow
396 vendor extensions. Default is no key.</dd>
399 <dt><code>key</code></dt>
400 <dd>Optional. Shorthand to set <code>in_key</code> and
401 <code>out_key</code> at the same time.</dd>
404 <dt><code>tos</code></dt>
405 <dd>Optional. The value of the ToS bits to be set on the
406 encapsulating packet. It may also be the word
407 <code>inherit</code>, in which case the ToS will be copied from
408 the inner packet if it is IPv4 or IPv6 (otherwise it will be
409 0). Note that the ECN fields are always inherited. Default is
413 <dt><code>ttl</code></dt>
414 <dd>Optional. The TTL to be set on the encapsulating packet.
415 It may also be the word <code>inherit</code>, in which case the
416 TTL will be copied from the inner packet if it is IPv4 or IPv6
417 (otherwise it will be the system default, typically 64).
418 Default is the system default TTL.</dd>
421 <dt><code>csum</code></dt>
422 <dd>Optional. Compute GRE checksums for outgoing packets and
423 require checksums for incoming packets. Default is enabled,
424 set to <code>false</code> to disable.</dd>
427 <dt><code>pmtud</code></dt>
428 <dd>Optional. Enable tunnel path MTU discovery. If enabled
429 ``ICMP destination unreachable - fragmentation'' needed
430 messages will be generated for IPv4 packets with the DF bit set
431 and IPv6 packets above the minimum MTU if the packet size
432 exceeds the path MTU minus the size of the tunnel headers. It
433 also forces the encapsulating packet DF bit to be set (it is
434 always set if the inner packet implies path MTU discovery).
435 Note that this option causes behavior that is typically
436 reserved for routers and therefore is not entirely in
437 compliance with the IEEE 802.1D specification for bridges.
438 Default is enabled, set to <code>false</code> to disable.</dd>
441 <dt><code>patch</code></dt>
442 <dd>A pair of virtual devices that act as a patch cable. A
443 <code>peer</code> argument is required that indicates the name
444 of the other side of the patch. Since a patch must work in
445 pairs, a second patch interface must be declared with the
446 <code>name</code> and <code>peer</code> arguments reversed.</dd>
450 <column name="options">
451 Configuration options whose interpretation varies based on
452 <ref column="type"/>.
456 <group title="Ingress Policing">
457 <column name="ingress_policing_burst">
458 <p>Maximum burst size for data received on this interface, in kb. The
459 default burst size if set to <code>0</code> is 1000 kb. This value
460 has no effect if <ref column="ingress_policing_rate"/>
461 is <code>0</code>.</p>
462 <p>The burst size should be at least the size of the interface's
466 <column name="ingress_policing_rate">
467 <p>Maximum rate for data received on this interface, in kbps. Data
468 received faster than this rate is dropped. Set to <code>0</code> to
469 disable policing.</p>
470 <p>The meaning of ``ingress'' is from Open vSwitch's perspective. If
471 configured on a physical interface, then it limits the rate at which
472 traffic is allowed into the system from the outside. If configured
473 on a virtual interface that is connected to a virtual machine, then
474 it limits the rate at which the guest is able to transmit.</p>
478 <group title="Other Features">
479 <column name="external_ids">
480 <p>Key-value pairs that identify this interface's role in external
481 systems. All of the currently defined key-value pairs specifically
482 apply to an interface that represents a virtual Ethernet interface
483 connected to a virtual machine. These key-value pairs should not be
484 present for other types of interfaces. Keys whose names end
485 in <code>-uuid</code> have values that uniquely identify the entity
486 in question. For a Citrix XenServer hypervisor, these values are
487 UUIDs in RFC 4122 format. Other hypervisors may use other
489 <p>The currently defined key-value pairs are:</p>
491 <dt><code>vif-uuid</code></dt>
492 <dd>The virtual interface associated with this interface.</dd>
493 <dt><code>network-uuid</code></dt>
494 <dd>The virtual network to which this interface is attached.</dd>
495 <dt><code>vm-uuid</code></dt>
496 <dd>The VM to which this interface belongs.</dd>
497 <dt><code>vif-mac</code></dt>
498 <dd>The MAC address programmed into the "virtual hardware" for this
500 form <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
501 For Citrix XenServer, this is the value of the <code>MAC</code>
502 field in the VIF record for this interface.</dd>
508 <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
509 <p>A port mirror within a <ref table="Bridge"/>.</p>
510 <p>A port mirror configures a bridge to send selected frames to special
511 ``mirrored'' ports, in addition to their normal destinations. Mirroring
512 traffic may also be referred to as SPAN or RSPAN, depending on the
513 mechanism used for delivery.</p>
516 Arbitrary identifier for the <ref table="Mirror"/>.
519 <group title="Selecting Packets for Mirroring">
520 <column name="select_all">
521 If true, every packet arriving or departing on any port is
522 selected for mirroring.
525 <column name="select_dst_port">
526 Ports on which departing packets are selected for mirroring.
529 <column name="select_src_port">
530 Ports on which arriving packets are selected for mirroring.
533 <column name="select_vlan">
534 VLANs on which packets are selected for mirroring. An empty set
535 selects packets on all VLANs.
539 <group title="Mirroring Destination Configuration">
540 <column name="output_port">
541 <p>Output port for selected packets, if nonempty. Mutually exclusive
542 with <ref column="output_vlan"/>.</p>
543 <p>Specifying a port for mirror output reserves that port exclusively
544 for mirroring. No frames other than those selected for mirroring
545 will be forwarded to the port, and any frames received on the port
546 will be discarded.</p>
547 <p>This type of mirroring is sometimes called SPAN.</p>
550 <column name="output_vlan">
551 <p>Output VLAN for selected packets, if nonempty. Mutually exclusive
552 with <ref column="output_port"/>.</p>
553 <p>The frames will be sent out all ports that trunk
554 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
555 <ref column="output_vlan"/>. When a mirrored frame is sent out a
556 trunk port, the frame's VLAN tag will be set to
557 <ref column="output_vlan"/>, replacing any existing tag; when it is
558 sent out an implicit VLAN port, the frame will not be tagged. This
559 type of mirroring is sometimes called RSPAN.</p>
560 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
561 contains unmanaged switches. Consider an unmanaged physical switch
562 with two ports: port 1, connected to an end host, and port 2,
563 connected to an Open vSwitch configured to mirror received packets
564 into VLAN 123 on port 2. Suppose that the end host sends a packet on
565 port 1 that the physical switch forwards to port 2. The Open vSwitch
566 forwards this packet to its destination and then reflects it back on
567 port 2 in VLAN 123. This reflected packet causes the unmanaged
568 physical switch to replace the MAC learning table entry, which
569 correctly pointed to port 1, with one that incorrectly points to port
570 2. Afterward, the physical switch will direct packets destined for
571 the end host to the Open vSwitch on port 2, instead of to the end
572 host on port 1, disrupting connectivity. If mirroring to a VLAN is
573 desired in this scenario, then the physical switch must be replaced
574 by one that learns Ethernet addresses on a per-VLAN basis. In
575 addition, learning should be disabled on the VLAN containing mirrored
576 traffic. If this is not done then intermediate switches will learn
577 the MAC address of each end host from the mirrored traffic. If
578 packets being sent to that end host are also mirrored, then they will
579 be dropped since the switch will attempt to send them out the input
580 port. Disabling learning for the VLAN will cause the switch to
581 correctly send the packet out all ports configured for that VLAN. If
582 Open vSwitch is being used as an intermediate switch, learning can be
583 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
584 in the appropriate <ref table="Bridge"/> table or tables.</p>
589 <table name="Controller" title="OpenFlow controller configuration.">
590 An OpenFlow controller.
592 <group title="Core Features">
593 <column name="target">
594 Connection method for controller.
595 The following connection methods are currently
598 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
600 <p>The specified SSL <var>port</var> (default: 6633) on the host at
601 the given <var>ip</var>, which must be expressed as an IP address
602 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
603 column in the <ref table="Open_vSwitch"/> must point to a valid
604 SSL configuration when this form is used.</p>
605 <p>SSL support is an optional feature that is not always built as
606 part of Open vSwitch.</p>
608 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
609 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
610 the given <var>ip</var>, which must be expressed as an IP address
611 (not a DNS name).</dd>
612 <dt><code>discover</code></dt>
613 <dd>Enables controller discovery.</dd>
614 <dt><code>none</code></dt>
615 <dd>Disables the controller.</dd>
619 <column name="connection_mode">
620 Either <code>in-band</code> or <code>out-of-band</code>. If not
621 specified, the default is implementation-specific.
625 <group title="Controller Failure Detection and Handling">
626 <column name="max_backoff">
627 Maximum number of milliseconds to wait between connection attempts.
628 Default is implementation-specific.
631 <column name="inactivity_probe">
632 Maximum number of milliseconds of idle time on connection to
633 controller before sending an inactivity probe message. If Open
634 vSwitch does not communicate with the controller for the specified
635 number of seconds, it will send a probe. If a response is not
636 received for the same additional amount of time, Open vSwitch
637 assumes the connection has been broken and attempts to reconnect.
638 Default is implementation-specific.
641 <column name="fail_mode">
642 <p>When a controller is configured, it is, ordinarily, responsible
643 for setting up all flows on the switch. Thus, if the connection to
644 the controller fails, no new network connections can be set up.
645 If the connection to the controller stays down long enough,
646 no packets can pass through the switch at all. This setting
647 determines the switch's response to such a situation. It may be set
648 to one of the following:
650 <dt><code>standalone</code></dt>
651 <dd>If no message is received from the controller for three
652 times the inactivity probe interval
653 (see <ref column="inactivity_probe"/>), then Open vSwitch
654 will take over responsibility for setting up flows. In
655 this mode, Open vSwitch causes the datapath to act like an
656 ordinary MAC-learning switch. Open vSwitch will continue
657 to retry connecting to the controller in the background
658 and, when the connection succeeds, it will discontinue its
659 standalone behavior.</dd>
660 <dt><code>secure</code></dt>
661 <dd>Open vSwitch will not set up flows on its own when the
662 controller connection fails. It will continue retry
663 connecting to the controller forever.</dd>
666 <p>If this value is unset, the default is
667 implementation-specific.</p>
671 <group title="OpenFlow Rate Limiting">
672 <column name="controller_burst_limit">
673 In conjunction with <ref column="controller_rate_limit"/>,
674 the maximum number of unused packet credits that the bridge will
675 allow to accumulate, in packets. If not specified, the default
676 is implementation-specific.
679 <column name="controller_rate_limit">
680 <p>The maximum rate at which packets in unknown flows will be
681 forwarded to the OpenFlow controller, in packets per second. This
682 feature prevents a single bridge from overwhelming the controller.
683 If not specified, the default is implementation-specific.</p>
684 <p>In addition, when a high rate triggers rate-limiting, Open
685 vSwitch queues controller packets for each port and transmits
686 them to the controller at the configured rate. The number of
687 queued packets is limited by
688 the <ref column="controller_burst_limit"/> value. The packet
689 queue is shared fairly among the ports on a bridge.</p><p>Open
690 vSwitch maintains two such packet rate-limiters per bridge.
691 One of these applies to packets sent up to the controller
692 because they do not correspond to any flow. The other applies
693 to packets sent up to the controller by request through flow
694 actions. When both rate-limiters are filled with packets, the
695 actual rate that packets are sent to the controller is up to
696 twice the specified rate.</p>
700 <group title="Additional Configuration for Discovery">
701 <column name="discover_accept_regex">
702 If <ref column="target"/> is <code>discover</code>, a POSIX
703 extended regular expression against which the discovered controller
704 location is validated. The regular expression is implicitly
705 anchored at the beginning of the controller location string, as
706 if it begins with <code>^</code>. If not specified, the default
707 is implementation-specific.
710 <column name="discover_update_resolv_conf">
711 If <ref column="target"/> is <code>discover</code>,
712 whether to update <code>/etc/resolv.conf</code> when the
713 controller is discovered. If not specified, the default
714 is implementation-specific. Open vSwitch will only modify
715 <code>/etc/resolv.conf</code> if the DHCP response that it receives
716 specifies one or more DNS servers.
720 <group title="Additional Configuration without Discovery">
721 <column name="local_gateway">
722 If <ref column="target"/> is not <code>discover</code>, the IP
723 address of the gateway to configure on the local port.
726 <column name="local_ip">
727 If <ref column="target"/> is not <code>discover</code>, the IP
728 address to configure on the local port.
731 <column name="local_netmask">
732 If <ref column="target"/> is not <code>discover</code>, the IP
733 netmask to configure on the local port.
738 <table name="NetFlow">
739 A NetFlow target. NetFlow is a protocol that exports a number of
740 details about terminating IP flows, such as the principals involved
743 <column name="targets">
744 NetFlow targets in the form
745 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
746 must be specified numerically, not as a DNS name.
749 <column name="engine_id">
750 Engine ID to use in NetFlow messages. Defaults to datapath index
754 <column name="engine_type">
755 Engine type to use in NetFlow messages. Defaults to datapath
756 index if not specified.
759 <column name="active_timeout">
760 The interval at which NetFlow records are sent for flows that are
761 still active, in seconds. A value of <code>0</code> requests the
762 default timeout (currently 600 seconds); a value of <code>-1</code>
763 disables active timeouts.
766 <column name="add_id_to_interface">
767 <p>If this column's value is <code>false</code>, the ingress and egress
768 interface fields of NetFlow flow records are derived from OpenFlow port
769 numbers. When it is <code>true</code>, the 7 most significant bits of
770 these fields will be replaced by the least significant 7 bits of the
771 engine id. This is useful because many NetFlow collectors do not
772 expect multiple switches to be sending messages from the same host, so
773 they do not store the engine information which could be used to
774 disambiguate the traffic.</p>
775 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
780 SSL configuration for an Open_vSwitch.
782 <column name="private_key">
783 Name of a PEM file containing the private key used as the switch's
784 identity for SSL connections to the controller.
787 <column name="certificate">
788 Name of a PEM file containing a certificate, signed by the
789 certificate authority (CA) used by the controller and manager,
790 that certifies the switch's private key, identifying a trustworthy
794 <column name="ca_cert">
795 Name of a PEM file containing the CA certificate used to verify
796 that the switch is connected to a trustworthy controller.
799 <column name="bootstrap_ca_cert">
800 If set to <code>true</code>, then Open vSwitch will attempt to
801 obtain the CA certificate from the controller on its first SSL
802 connection and save it to the named PEM file. If it is successful,
803 it will immediately drop the connection and reconnect, and from then
804 on all SSL connections must be authenticated by a certificate signed
805 by the CA certificate thus obtained. <em>This option exposes the
806 SSL connection to a man-in-the-middle attack obtaining the initial
807 CA certificate.</em> It may still be useful for bootstrapping.
812 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
815 <column name="agent">
816 IP address to report as ``agent address'' to collectors. If not
817 specified, defaults to the <ref table="Controller" column="local_ip"/> in
818 the collector's <ref table="Controller"/>. If neither is specified,
822 <column name="header">
823 Number of bytes of a sampled packet to send to the collector.
824 If not specified, the default is 128 bytes.
827 <column name="polling">
828 Polling rate in seconds to send port statistics to the collector.
829 If not specified, defaults to 30 seconds.
832 <column name="sampling">
833 Rate at which packets should be sampled and sent to the collector.
834 If not specified, defaults to 400, which means one out of 400
835 packets, on average, will be sent to the collector.
838 <column name="targets">
839 sFlow targets in the form
840 <code><var>ip</var>:<var>port</var></code>.