vswitchd/vswitch.xml

   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>
   8
   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.
  12
  13     <group title="Configuration">
  14       <column name="bridges">
  15         Set of bridges managed by the daemon.
  16       </column>
  17
  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"/>.
  22       </column>
  23
  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.
  27       </column>
  28
  29       <column name="ssl">
  30         SSL used globally by the daemon.
  31       </column>
  32
  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:
  36         <dl>
  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>
  42         </dl>
  43       </column>
  44     </group>
  45
  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
  51         this sequence number.
  52       </column>
  53
  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.
  58       </column>
  59     </group>
  60   </table>
  61
  62   <table name="Bridge">
  63     <p>
  64       Configuration for a bridge within an
  65       <ref table="Open_vSwitch"/>.
  66     </p>
  67     <p>
  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.
  71     </p>
  72
  73     <group title="Core Features">
  74       <column name="name">
  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
  77         bridges on a host.
  78       </column>
  79
  80       <column name="ports">
  81         Ports included in the bridge.
  82       </column>
  83
  84       <column name="mirrors">
  85         Port mirroring configuration.
  86       </column>
  87
  88       <column name="netflow">
  89         NetFlow configuration.
  90       </column>
  91
  92       <column name="sflow">
  93         sFlow configuration.
  94       </column>
  95
  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.
 102       </column>
 103     </group>
 104
 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.
 111       </column>
 112
 113       <column name="datapath_id">
 114         Reports the OpenFlow datapath ID in use.  Exactly 16 hex digits.
 115       </column>
 116     </group>
 117
 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>.
 123       </column>
 124
 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:
 128         <dl>
 129           <dt><code>xs-network-uuids</code></dt>
 130           <dd>Space-delimited set of the Citrix XenServer network UUIDs with
 131             which this bridge is associated.</dd>
 132         </dl>
 133       </column>
 134
 135       <column name="other_config">
 136         Key-value pairs for configuring rarely used bridge
 137         features.  The currently defined key-value pairs are:
 138         <dl>
 139           <dt><code>datapath-id</code></dt>
 140           <dd>Exactly 16 hex
 141             digits to set the OpenFlow datapath ID to a specific
 142             value.</dd>
 143           <dt><code>hwaddr</code></dt>
 144           <dd>An Ethernet address in the form
 145             <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
 146             to set the hardware address of the local port and influence the
 147             datapath ID.</dd>
 148         </dl>
 149       </column>
 150     </group>
 151   </table>
 152
 153   <table name="Port" table="Port or bond configuration.">
 154     <p>A port within a <ref table="Bridge"/>.</p>
 155     <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
 156       <ref column="interfaces"/> column.  Such a port logically
 157       corresponds to a port on a physical Ethernet switch.  A port
 158       with more than one interface is a ``bonded port'' (see
 159       <ref group="Bonding Configuration"/>).</p>
 160     <p>Some properties that one might think as belonging to a port are actually
 161       part of the port's <ref table="Interface"/> members.</p>
 162
 163     <column name="name">
 164       Port name.  Should be alphanumeric and no more than about 8
 165       bytes long.  May be the same as the interface name, for
 166       non-bonded ports.  Must otherwise be unique among the names of
 167       ports, interfaces, and bridges on a host.
 168     </column>
 169
 170     <column name="interfaces">
 171       The port's interfaces.  If there is more than one, this is a
 172       bonded Port.
 173     </column>
 174
 175     <group title="VLAN Configuration">
 176       <p>A bridge port must be configured for VLANs in one of two
 177         mutually exclusive ways:
 178         <ul>
 179           <li>A ``trunk port'' has an empty value for
 180             <ref column="tag"/> and a possibly non-empty
 181             <ref column="trunks"/> value.</li>
 182           <li>An ``implicitly tagged VLAN port'' or ``access port''
 183             has an nonempty value for <ref column="tag"/> and an empty
 184             <ref column="trunks"/> value.</li>
 185         </ul>
 186         If <ref column="trunks"/> and <ref column="tag"/> are both
 187         nonempty, the configuration is ill-formed.
 188       </p>
 189
 190       <column name="tag">
 191         <p>If nonempty, this port's implicitly tagged VLAN.  Frames
 192           arriving on trunk ports will be forwarded to this port only
 193           if they are tagged with the given VLAN.  Frames arriving on
 194           other VLAN ports will be forwarded to this port only if they
 195           have the same <ref column="tag"/> value.  Frames forwarded
 196           to this port will not have an 802.1Q header.</p>
 197         <p>When a frame with a 802.1Q header that indicates a nonzero VLAN is
 198           received on an implicit VLAN port, it is discarded.</p>
 199         <p>Must be empty if this is a trunk port.</p>
 200       </column>
 201
 202       <column name="trunks">
 203         <p>The 802.1Q VLAN(s) that this port trunks.  If the column is
 204           empty, then the port trunks all VLANs as well as packets that
 205           have no VLAN header.  Otherwise, only frames that have an
 206           802.1Q header with one of the specified VLANs are accepted.
 207           If <code>0</code> is included, then frames without an 802.1Q
 208           header are also accepted.</p>
 209         <p>Must be empty unless this is a trunk port.</p>
 210       </column>
 211     </group>
 212
 213     <group title="Bonding Configuration">
 214       <p>A port that has more than one interface is a ``bonded port.''
 215         Bonding allows for load balancing and fail-over.  Open vSwitch
 216         supports ``source load balancing'' (SLB) bonding, which
 217         assigns flows to slaves based on source MAC address, with
 218         periodic rebalancing as traffic patterns change.  This form of
 219         bonding does not require 802.3ad or other special support from
 220         the upstream switch to which the slave devices are
 221         connected.</p>
 222
 223       <p>These columns apply only to bonded ports.  Their values are
 224         otherwise ignored.</p>
 225
 226       <column name="bond_updelay">
 227         <p>For a bonded port, the number of milliseconds for which carrier must
 228           stay up on an interface before the interface is considered to be up.
 229           Specify <code>0</code> to enable the interface immediately.</p>
 230         <p>This setting is honored only when at least one bonded interface is
 231           already enabled.  When no interfaces are enabled, then the first bond
 232           interface to come up is enabled immediately.</p>
 233       </column>
 234
 235       <column name="bond_downdelay">
 236         For a bonded port, the number of milliseconds for which carrier must
 237         stay down on an interface before the interface is considered to be
 238         down.  Specify <code>0</code> to disable the interface immediately.
 239       </column>
 240
 241       <column name="bond_fake_iface">
 242         For a bonded port, whether to create a fake internal interface with the
 243         name of the port.  Use only for compatibility with legacy software that
 244         requires this.
 245       </column>
 246     </group>
 247
 248     <group title="Other Features">
 249       <column name="mac">
 250         The MAC address to use for this port for the purpose of choosing the
 251         bridge's MAC address.  This column does not necessarily reflect the
 252         port's actual MAC address, nor will setting it change the port's actual
 253         MAC address.
 254       </column>
 255
 256       <column name="fake_bridge">
 257         Does this port represent a sub-bridge for its tagged VLAN within the
 258         Bridge?  See ovs-vsctl(8) for more information.
 259       </column>
 260
 261       <column name="external_ids">
 262         Key-value pairs that identify this port's role in external systems.  No
 263         key-value pairs native to <ref table="Port"/> are currently defined.
 264         For fake bridges (see the <ref column="fake_bridge"/> column), external
 265         IDs for the fake bridge are defined here by prefixing a
 266         <ref table="Bridge"/> <ref table="Bridge" column="external_ids"/> key
 267         with <code>fake-bridge-</code>,
 268         e.g. <code>fake-bridge-xs-network-uuids</code>.
 269       </column>
 270
 271       <column name="other_config">
 272         Key-value pairs for configuring rarely used port features.  The
 273         currently defined key-value pairs are:
 274         <dl>
 275           <dt><code>hwaddr</code></dt>
 276           <dd>An Ethernet address in the form
 277             <code><var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var></code>.</dd>
 278         </dl>
 279       </column>
 280     </group>
 281   </table>
 282
 283   <table name="Interface" title="One physical network device in a Port.">
 284     An interface within a <ref table="Port"/>.
 285
 286     <group title="Core Features">
 287       <column name="name">
 288         Interface name.  Should be alphanumeric and no more than about 8 bytes
 289         long.  May be the same as the port name, for non-bonded ports.  Must
 290         otherwise be unique among the names of ports, interfaces, and bridges
 291         on a host.
 292       </column>
 293
 294       <column name="mac">
 295         <p>Ethernet address to set for this interface.  If unset then the
 296           default MAC address is used:</p>
 297         <ul>
 298           <li>For the local interface, the default is the lowest-numbered MAC
 299             address among the other bridge ports, either the value of the
 300             <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
 301             if set, or its actual MAC (for bonded ports, the MAC of its slave
 302             whose name is first in alphabetical order).  Internal ports and
 303             bridge ports that are used as port mirroring destinations (see the
 304             <ref table="Mirror"/> table) are ignored.</li>
 305           <li>For other internal interfaces, the default MAC is randomly
 306             generated.</li>
 307           <li>External interfaces typically have a MAC address associated with
 308             their hardware.</li>
 309         </ul>
 310         <p>Some interfaces may not have a software-controllable MAC
 311         address.</p>
 312       </column>
 313
 314       <column name="ofport">
 315         <p>OpenFlow port number for this interface.  Unlike most columns, this
 316           column's value should be set only by Open vSwitch itself.  Other
 317           clients should set this column to an empty set (the default) when
 318           creating an <ref table="Interface"/>.</p>
 319         <p>Open vSwitch populates this column when the port number becomes
 320           known.  If the interface is successfully added,
 321           <ref column="ofport"/> will be set to a number between 1 and 65535
 322           (generally either in the range 1 to 65280, exclusive, or 65534, the
 323           port number for the OpenFlow ``local port'').  If the interface
 324           cannot be added then Open vSwitch sets this column
 325           to -1.</p>
 326       </column>
 327     </group>
 328
 329     <group title="System-Specific Details">
 330       <column name="type">
 331         The interface type, one of:
 332         <dl>
 333           <dt><code>system</code></dt>
 334           <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
 335             Sometimes referred to as ``external interfaces'' since they are
 336             generally connected to hardware external to that on which the Open
 337             vSwitch is running.  The empty string is a synonym for
 338             <code>system</code>.</dd>
 339           <dt><code>internal</code></dt>
 340           <dd>A simulated network device that sends and receives traffic.  An
 341             internal interface whose <ref column="name"/> is the same as its
 342             bridge's <ref table="Open_vSwitch" column="name"/> is called the
 343             ``local interface.''  It does not make sense to bond an internal
 344             interface, so the terms ``port'' and ``interface'' are often used
 345             imprecisely for internal interfaces.</dd>
 346           <dt><code>tap</code></dt>
 347           <dd>A TUN/TAP device managed by Open vSwitch.</dd>
 348           <dt><code>gre</code></dt>
 349           <dd>A GRE tunnel device managed by Open vSwitch.</dd>
 350         </dl>
 351       </column>
 352
 353       <column name="options">
 354         Configuration options whose interpretation varies based on
 355         <ref column="type"/>.
 356       </column>
 357     </group>
 358
 359     <group title="Ingress Policing">
 360       <column name="ingress_policing_burst">
 361         <p>Maximum burst size for data received on this interface, in kb.  The
 362           default burst size if set to <code>0</code> is 1000 kb.  This value
 363           has no effect if <ref column="ingress_policing_rate"/>
 364           is <code>0</code>.</p>
 365         <p>The burst size should be at least the size of the interface's
 366           MTU.</p>
 367       </column>
 368
 369       <column name="ingress_policing_rate">
 370         <p>Maximum rate for data received on this interface, in kbps.  Data
 371           received faster than this rate is dropped.  Set to <code>0</code> to
 372           disable policing.</p>
 373         <p>The meaning of ``ingress'' is from Open vSwitch's perspective.  If
 374           configured on a physical interface, then it limits the rate at which
 375           traffic is allowed into the system from the outside.  If configured
 376           on a virtual interface that is connected to a virtual machine, then
 377           it limits the rate at which the guest is able to transmit.</p>
 378       </column>
 379     </group>
 380
 381     <group title="Other Features">
 382       <column name="external_ids">
 383         <p>Key-value pairs that identify this interface's role in external
 384           systems.  All of the currently defined key-value pairs specifically
 385           apply to an interface that represents a virtual Ethernet interface
 386           connected to a virtual machine.  These key-value pairs should not be
 387           present for other types of interfaces.  Keys whose names end
 388           in <code>-uuid</code> have values that uniquely identify the entity
 389           in question.  For a Citrix XenServer hypervisor, these values are
 390           UUIDs in RFC 4122 format.  Other hypervisors may use other
 391           formats.</p>
 392         <p>The currently defined key-value pairs are:</p>
 393         <dl>
 394           <dt><code>vif-uuid</code></dt>
 395           <dd>The virtual interface associated with this interface.</dd>
 396           <dt><code>network-uuid</code></dt>
 397           <dd>The virtual network to which this interface is attached.</dd>
 398           <dt><code>vm-uuid</code></dt>
 399           <dd>The VM to which this interface belongs.</dd>
 400           <dt><code>vif-mac</code></dt>
 401           <dd>The MAC address programmed into the "virtual hardware" for this
 402               interface, in the
 403               form <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
 404               For Citrix XenServer, this is the value of the <code>MAC</code>
 405               field in the VIF record for this interface.</dd>
 406         </dl>
 407       </column>
 408     </group>
 409   </table>
 410
 411   <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
 412     <p>A port mirror within a <ref table="Bridge"/>.</p>
 413     <p>A port mirror configures a bridge to send selected frames to special
 414       ``mirrored'' ports, in addition to their normal destinations.  Mirroring
 415       traffic may also be referred to as SPAN or RSPAN, depending on the
 416       mechanism used for delivery.</p>
 417
 418     <column name="name">
 419       Arbitrary identifier for the <ref table="Mirror"/>.
 420     </column>
 421
 422     <group title="Selecting Packets for Mirroring">
 423       <column name="select_dst_port">
 424         Ports on which departing packets are selected for mirroring.
 425       </column>
 426
 427       <column name="select_src_port">
 428         Ports on which arriving packets are selected for mirroring.  If this
 429         column and <ref column="select_dst_port"/> are both empty, then all
 430         packets on all ports are selected for mirroring.
 431       </column>
 432
 433       <column name="select_vlan">
 434         VLANs on which packets are selected for mirroring.  An empty set
 435         selects packets on all VLANs.
 436       </column>
 437     </group>
 438
 439     <group title="Mirroring Destination Configuration">
 440       <column name="output_port">
 441         <p>Output port for selected packets, if nonempty.  Mutually exclusive
 442           with <ref column="output_vlan"/>.</p>
 443         <p>Specifying a port for mirror output reserves that port exclusively
 444           for mirroring.  No frames other than those selected for mirroring
 445           will be forwarded to the port, and any frames received on the port
 446           will be discarded.</p>
 447         <p>This type of mirroring is sometimes called SPAN.</p>
 448       </column>
 449
 450       <column name="output_vlan">
 451         <p>Output VLAN for selected packets, if nonempty.  Mutually exclusive
 452           with <ref column="output_port"/>.</p>
 453         <p>The frames will be sent out all ports that trunk
 454           <ref column="output_vlan"/>, as well as any ports with implicit VLAN
 455           <ref column="output_vlan"/>.  When a mirrored frame is sent out a
 456           trunk port, the frame's VLAN tag will be set to
 457           <ref column="output_vlan"/>, replacing any existing tag; when it is
 458           sent out an implicit VLAN port, the frame will not be tagged.  This
 459           type of mirroring is sometimes called RSPAN.</p>
 460         <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
 461           contains unmanaged switches.  Consider an unmanaged physical switch
 462           with two ports: port 1, connected to an end host, and port 2,
 463           connected to an Open vSwitch configured to mirror received packets
 464           into VLAN 123 on port 2.  Suppose that the end host sends a packet on
 465           port 1 that the physical switch forwards to port 2.  The Open vSwitch
 466           forwards this packet to its destination and then reflects it back on
 467           port 2 in VLAN 123.  This reflected packet causes the unmanaged
 468           physical switch to replace the MAC learning table entry, which
 469           correctly pointed to port 1, with one that incorrectly points to port
 470           2.  Afterward, the physical switch will direct packets destined for
 471           the end host to the Open vSwitch on port 2, instead of to the end
 472           host on port 1, disrupting connectivity.  If mirroring to a VLAN is
 473           desired in this scenario, then the physical switch must be replaced
 474           by one that learns Ethernet addresses on a per-VLAN basis.  In
 475           addition, learning should be disabled on the VLAN containing mirrored
 476           traffic. If this is not done then intermediate switches will learn
 477           the MAC address of each end host from the mirrored traffic.  If
 478           packets being sent to that end host are also mirrored, then they will
 479           be dropped since the switch will attempt to send them out the input
 480           port. Disabling learning for the VLAN will cause the switch to
 481           correctly send the packet out all ports configured for that VLAN.  If
 482           Open vSwitch is being used as an intermediate switch, learning can be
 483           disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
 484           in the appropriate <ref table="Bridge"/> table or tables.</p>
 485       </column>
 486     </group>
 487   </table>
 488
 489   <table name="Controller" title="OpenFlow controller configuration.">
 490     An OpenFlow controller.
 491
 492     <group title="Core Features">
 493       <column name="target">
 494         Connection method for controller.
 495         The following connection methods are currently
 496         supported:
 497         <dl>
 498           <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
 499           <dd>
 500             <p>The specified SSL <var>port</var> (default: 6633) on the host at
 501               the given <var>ip</var>, which must be expressed as an IP address
 502               (not a DNS name).  The <ref table="Open_vSwitch" column="ssl"/>
 503               column in the <ref table="Open_vSwitch"/> must point to a valid
 504               SSL configuration when this form is used.</p>
 505             <p>SSL support is an optional feature that is not always built as
 506               part of Open vSwitch.</p>
 507           </dd>
 508           <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
 509           <dd>The specified TCP <var>port</var> (default: 6633) on the host at
 510             the given <var>ip</var>, which must be expressed as an IP address
 511             (not a DNS name).</dd>
 512           <dt><code>discover</code></dt>
 513           <dd>Enables controller discovery.</dd>
 514           <dt><code>none</code></dt>
 515           <dd>Disables the controller.</dd>
 516         </dl>
 517       </column>
 518
 519       <column name="connection_mode">
 520         Either <code>in-band</code> or <code>out-of-band</code>.  If not
 521         specified, the default is implementation-specific.
 522       </column>
 523     </group>
 524
 525     <group title="Controller Failure Detection and Handling">
 526       <column name="max_backoff">
 527         Maximum number of milliseconds to wait between connection attempts.
 528         Default is implementation-specific.
 529       </column>
 530
 531       <column name="inactivity_probe">
 532         Maximum number of milliseconds of idle time on connection to
 533         controller before sending an inactivity probe message.  If Open
 534         vSwitch does not communicate with the controller for the specified
 535         number of seconds, it will send a probe.  If a response is not
 536         received for the same additional amount of time, Open vSwitch
 537         assumes the connection has been broken and attempts to reconnect.
 538         Default is implementation-specific.
 539       </column>
 540
 541       <column name="fail_mode">
 542         <p>When a controller is configured, it is, ordinarily, responsible
 543           for setting up all flows on the switch.  Thus, if the connection to
 544           the controller fails, no new network connections can be set up.
 545           If the connection to the controller stays down long enough,
 546           no packets can pass through the switch at all.  This setting
 547           determines the switch's response to such a situation.  It may be set
 548           to one of the following:
 549           <dl>
 550             <dt><code>standalone</code></dt>
 551             <dd>If no message is received from the controller for three
 552               times the inactivity probe interval
 553               (see <ref column="inactivity_probe"/>), then Open vSwitch
 554               will take over responsibility for setting up flows.  In
 555               this mode, Open vSwitch causes the datapath to act like an
 556               ordinary MAC-learning switch.  Open vSwitch will continue
 557               to retry connecting to the controller in the background
 558               and, when the connection succeeds, it will discontinue its
 559               standalone behavior.</dd>
 560             <dt><code>secure</code></dt>
 561             <dd>Open vSwitch will not set up flows on its own when the
 562               controller connection fails.  It will continue retry
 563               connecting to the controller forever.</dd>
 564           </dl>
 565         </p>
 566         <p>If this value is unset, the default is
 567         implementation-specific.</p>
 568       </column>
 569     </group>
 570
 571     <group title="OpenFlow Rate Limiting">
 572         <column name="controller_burst_limit">
 573           In conjunction with <ref column="controller_rate_limit"/>,
 574           the maximum number of unused packet credits that the bridge will
 575           allow to accumulate, in packets.  If not specified, the default
 576           is implementation-specific.
 577         </column>
 578
 579         <column name="controller_rate_limit">
 580           <p>The maximum rate at which packets in unknown flows will be
 581             forwarded to the OpenFlow controller, in packets per second.  This
 582             feature prevents a single bridge from overwhelming the controller.
 583             If not specified, the default is implementation-specific.</p>
 584           <p>In addition, when a high rate triggers rate-limiting, Open
 585             vSwitch queues controller packets for each port and transmits
 586             them to the controller at the configured rate.  The number of
 587             queued packets is limited by
 588             the <ref column="controller_burst_limit"/> value.  The packet
 589             queue is shared fairly among the ports on a bridge.</p><p>Open
 590             vSwitch maintains two such packet rate-limiters per bridge.
 591             One of these applies to packets sent up to the controller
 592             because they do not correspond to any flow.  The other applies
 593             to packets sent up to the controller by request through flow
 594             actions. When both rate-limiters are filled with packets, the
 595             actual rate that packets are sent to the controller is up to
 596             twice the specified rate.</p>
 597         </column>
 598     </group>
 599
 600     <group title="Additional Configuration for Discovery">
 601       <column name="discover_accept_regex">
 602         If <ref column="target"/> is <code>discover</code>, a POSIX
 603         extended regular expression against which the discovered controller
 604         location is validated.  The regular expression is implicitly
 605         anchored at the beginning of the controller location string, as
 606         if it begins with <code>^</code>.  If not specified, the default
 607         is implementation-specific.
 608       </column>
 609
 610       <column name="discover_update_resolv_conf">
 611         If <ref column="target"/> is <code>discover</code>,
 612         whether to update <code>/etc/resolv.conf</code> when the
 613         controller is discovered.  If not specified, the default
 614         is implementation-specific.  Open vSwitch will only modify
 615         <code>/etc/resolv.conf</code> if the DHCP response that it receives
 616         specifies one or more DNS servers.
 617       </column>
 618     </group>
 619
 620     <group title="Additional Configuration without Discovery">
 621       <column name="local_gateway">
 622         If <ref column="target"/> is not <code>discover</code>, the IP
 623         address of the gateway to configure on the local port.
 624       </column>
 625
 626       <column name="local_ip">
 627         If <ref column="target"/> is not <code>discover</code>, the IP
 628         address to configure on the local port.
 629       </column>
 630
 631       <column name="local_netmask">
 632         If <ref column="target"/> is not <code>discover</code>, the IP
 633         netmask to configure on the local port.
 634       </column>
 635     </group>
 636   </table>
 637
 638   <table name="NetFlow">
 639     A NetFlow target.  NetFlow is a protocol that exports a number of
 640     details about terminating IP flows, such as the principals involved
 641     and duration.
 642
 643     <column name="targets">
 644       NetFlow targets in the form
 645       <code><var>ip</var>:<var>port</var></code>.  The <var>ip</var>
 646       must be specified numerically, not as a DNS name.
 647     </column>
 648
 649     <column name="engine_id">
 650       Engine ID to use in NetFlow messages.  Defaults to datapath index
 651       if not specified.
 652     </column>
 653
 654     <column name="engine_type">
 655       Engine type to use in NetFlow messages.  Defaults to datapath
 656       index if not specified.
 657     </column>
 658
 659     <column name="active_timeout">
 660       The interval at which NetFlow records are sent for flows that are
 661       still active, in seconds.  A value of <code>0</code> requests the
 662       default timeout (currently 600 seconds); a value of <code>-1</code>
 663       disables active timeouts.
 664     </column>
 665
 666     <column name="add_id_to_interface">
 667       <p>If this column's value is <code>false</code>, the ingress and egress
 668         interface fields of NetFlow flow records are derived from OpenFlow port
 669         numbers.  When it is <code>true</code>, the 7 most significant bits of
 670         these fields will be replaced by the least significant 7 bits of the
 671         engine id.  This is useful because many NetFlow collectors do not
 672         expect multiple switches to be sending messages from the same host, so
 673         they do not store the engine information which could be used to
 674         disambiguate the traffic.</p>
 675       <p>When this option is enabled, a maximum of 508 ports are supported.</p>
 676     </column>
 677   </table>
 678
 679   <table name="SSL">
 680     SSL configuration for an Open_vSwitch.
 681
 682     <column name="private_key">
 683       Name of a PEM file containing the private key used as the switch's
 684       identity for SSL connections to the controller.
 685     </column>
 686
 687     <column name="certificate">
 688       Name of a PEM file containing a certificate, signed by the
 689       certificate authority (CA) used by the controller and manager,
 690       that certifies the switch's private key, identifying a trustworthy
 691       switch.
 692     </column>
 693
 694     <column name="ca_cert">
 695       Name of a PEM file containing the CA certificate used to verify
 696       that the switch is connected to a trustworthy controller.
 697     </column>
 698
 699     <column name="bootstrap_ca_cert">
 700       If set to <code>true</code>, then Open vSwitch will attempt to
 701       obtain the CA certificate from the controller on its first SSL
 702       connection and save it to the named PEM file. If it is successful,
 703       it will immediately drop the connection and reconnect, and from then
 704       on all SSL connections must be authenticated by a certificate signed
 705       by the CA certificate thus obtained.  <em>This option exposes the
 706         SSL connection to a man-in-the-middle attack obtaining the initial
 707         CA certificate.</em>  It may still be useful for bootstrapping.
 708     </column>
 709   </table>
 710
 711   <table name="sFlow">
 712     <p>An sFlow(R) target.  sFlow is a protocol for remote monitoring
 713       of switches.</p>
 714
 715     <column name="agent">
 716       IP address to report as ``agent address'' to collectors.  If not
 717       specified, defaults to the <ref table="Controller" column="local_ip"/> in
 718       the collector's <ref table="Controller"/>.  If neither is specified,
 719       sFlow is disabled.
 720     </column>
 721
 722     <column name="header">
 723       Number of bytes of a sampled packet to send to the collector.
 724       If not specified, the default is 128 bytes.
 725     </column>
 726
 727     <column name="polling">
 728       Polling rate in seconds to send port statistics to the collector.
 729       If not specified, defaults to 30 seconds.
 730     </column>
 731
 732     <column name="sampling">
 733       Rate at which packets should be sampled and sent to the collector.
 734       If not specified, defaults to 400, which means one out of 400
 735       packets, on average, will be sent to the collector.
 736     </column>
 737
 738     <column name="targets">
 739       sFlow targets in the form
 740       <code><var>ip</var>:<var>port</var></code>.
 741     </column>
 742   </table>
 743 </database>