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>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>
 135         </dl>
 136       </column>
 137
 138       <column name="other_config">
 139         Key-value pairs for configuring rarely used bridge
 140         features.  The currently defined key-value pairs are:
 141         <dl>
 142           <dt><code>datapath-id</code></dt>
 143           <dd>Exactly 16 hex
 144             digits to set the OpenFlow datapath ID to a specific
 145             value.</dd>
 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
 150             datapath ID.</dd>
 151         </dl>
 152       </column>
 153     </group>
 154   </table>
 155
 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>
 165
 166     <column name="name">
 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.
 171     </column>
 172
 173     <column name="interfaces">
 174       The port's interfaces.  If there is more than one, this is a
 175       bonded Port.
 176     </column>
 177
 178     <group title="VLAN Configuration">
 179       <p>A bridge port must be configured for VLANs in one of two
 180         mutually exclusive ways:
 181         <ul>
 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>
 188         </ul>
 189         If <ref column="trunks"/> and <ref column="tag"/> are both
 190         nonempty, the configuration is ill-formed.
 191       </p>
 192
 193       <column name="tag">
 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>
 203       </column>
 204
 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>
 213       </column>
 214     </group>
 215
 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
 224         connected.</p>
 225
 226       <p>These columns apply only to bonded ports.  Their values are
 227         otherwise ignored.</p>
 228
 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>
 236       </column>
 237
 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.
 242       </column>
 243
 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
 247         requires this.
 248       </column>
 249     </group>
 250
 251     <group title="Other Features">
 252       <column name="mac">
 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
 256         MAC address.
 257       </column>
 258
 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.
 262       </column>
 263
 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>.
 272       </column>
 273
 274       <column name="other_config">
 275         Key-value pairs for configuring rarely used port features.  The
 276         currently defined key-value pairs are:
 277         <dl>
 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>
 288         </dl>
 289       </column>
 290     </group>
 291   </table>
 292
 293   <table name="Interface" title="One physical network device in a Port.">
 294     An interface within a <ref table="Port"/>.
 295
 296     <group title="Core Features">
 297       <column name="name">
 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
 301         on a host.
 302       </column>
 303
 304       <column name="mac">
 305         <p>Ethernet address to set for this interface.  If unset then the
 306           default MAC address is used:</p>
 307         <ul>
 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
 316             generated.</li>
 317           <li>External interfaces typically have a MAC address associated with
 318             their hardware.</li>
 319         </ul>
 320         <p>Some interfaces may not have a software-controllable MAC
 321         address.</p>
 322       </column>
 323
 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
 335           to -1.</p>
 336       </column>
 337     </group>
 338
 339     <group title="System-Specific Details">
 340       <column name="type">
 341         The interface type, one of:
 342         <dl>
 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>A GRE tunnel device managed by Open vSwitch.</dd>
 360         </dl>
 361       </column>
 362
 363       <column name="options">
 364         Configuration options whose interpretation varies based on
 365         <ref column="type"/>.
 366       </column>
 367     </group>
 368
 369     <group title="Ingress Policing">
 370       <column name="ingress_policing_burst">
 371         <p>Maximum burst size for data received on this interface, in kb.  The
 372           default burst size if set to <code>0</code> is 1000 kb.  This value
 373           has no effect if <ref column="ingress_policing_rate"/>
 374           is <code>0</code>.</p>
 375         <p>The burst size should be at least the size of the interface's
 376           MTU.</p>
 377       </column>
 378
 379       <column name="ingress_policing_rate">
 380         <p>Maximum rate for data received on this interface, in kbps.  Data
 381           received faster than this rate is dropped.  Set to <code>0</code> to
 382           disable policing.</p>
 383         <p>The meaning of ``ingress'' is from Open vSwitch's perspective.  If
 384           configured on a physical interface, then it limits the rate at which
 385           traffic is allowed into the system from the outside.  If configured
 386           on a virtual interface that is connected to a virtual machine, then
 387           it limits the rate at which the guest is able to transmit.</p>
 388       </column>
 389     </group>
 390
 391     <group title="Other Features">
 392       <column name="external_ids">
 393         <p>Key-value pairs that identify this interface's role in external
 394           systems.  All of the currently defined key-value pairs specifically
 395           apply to an interface that represents a virtual Ethernet interface
 396           connected to a virtual machine.  These key-value pairs should not be
 397           present for other types of interfaces.  Keys whose names end
 398           in <code>-uuid</code> have values that uniquely identify the entity
 399           in question.  For a Citrix XenServer hypervisor, these values are
 400           UUIDs in RFC 4122 format.  Other hypervisors may use other
 401           formats.</p>
 402         <p>The currently defined key-value pairs are:</p>
 403         <dl>
 404           <dt><code>vif-uuid</code></dt>
 405           <dd>The virtual interface associated with this interface.</dd>
 406           <dt><code>network-uuid</code></dt>
 407           <dd>The virtual network to which this interface is attached.</dd>
 408           <dt><code>vm-uuid</code></dt>
 409           <dd>The VM to which this interface belongs.</dd>
 410           <dt><code>vif-mac</code></dt>
 411           <dd>The MAC address programmed into the "virtual hardware" for this
 412               interface, in the
 413               form <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
 414               For Citrix XenServer, this is the value of the <code>MAC</code>
 415               field in the VIF record for this interface.</dd>
 416         </dl>
 417       </column>
 418     </group>
 419   </table>
 420
 421   <table name="Mirror" title="Port mirroring (SPAN/RSPAN).">
 422     <p>A port mirror within a <ref table="Bridge"/>.</p>
 423     <p>A port mirror configures a bridge to send selected frames to special
 424       ``mirrored'' ports, in addition to their normal destinations.  Mirroring
 425       traffic may also be referred to as SPAN or RSPAN, depending on the
 426       mechanism used for delivery.</p>
 427
 428     <column name="name">
 429       Arbitrary identifier for the <ref table="Mirror"/>.
 430     </column>
 431
 432     <group title="Selecting Packets for Mirroring">
 433       <column name="select_all">
 434         If true, every packet arriving or departing on any port is
 435         selected for mirroring.
 436       </column>
 437
 438       <column name="select_dst_port">
 439         Ports on which departing packets are selected for mirroring.
 440       </column>
 441
 442       <column name="select_src_port">
 443         Ports on which arriving packets are selected for mirroring.
 444       </column>
 445
 446       <column name="select_vlan">
 447         VLANs on which packets are selected for mirroring.  An empty set
 448         selects packets on all VLANs.
 449       </column>
 450     </group>
 451
 452     <group title="Mirroring Destination Configuration">
 453       <column name="output_port">
 454         <p>Output port for selected packets, if nonempty.  Mutually exclusive
 455           with <ref column="output_vlan"/>.</p>
 456         <p>Specifying a port for mirror output reserves that port exclusively
 457           for mirroring.  No frames other than those selected for mirroring
 458           will be forwarded to the port, and any frames received on the port
 459           will be discarded.</p>
 460         <p>This type of mirroring is sometimes called SPAN.</p>
 461       </column>
 462
 463       <column name="output_vlan">
 464         <p>Output VLAN for selected packets, if nonempty.  Mutually exclusive
 465           with <ref column="output_port"/>.</p>
 466         <p>The frames will be sent out all ports that trunk
 467           <ref column="output_vlan"/>, as well as any ports with implicit VLAN
 468           <ref column="output_vlan"/>.  When a mirrored frame is sent out a
 469           trunk port, the frame's VLAN tag will be set to
 470           <ref column="output_vlan"/>, replacing any existing tag; when it is
 471           sent out an implicit VLAN port, the frame will not be tagged.  This
 472           type of mirroring is sometimes called RSPAN.</p>
 473         <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
 474           contains unmanaged switches.  Consider an unmanaged physical switch
 475           with two ports: port 1, connected to an end host, and port 2,
 476           connected to an Open vSwitch configured to mirror received packets
 477           into VLAN 123 on port 2.  Suppose that the end host sends a packet on
 478           port 1 that the physical switch forwards to port 2.  The Open vSwitch
 479           forwards this packet to its destination and then reflects it back on
 480           port 2 in VLAN 123.  This reflected packet causes the unmanaged
 481           physical switch to replace the MAC learning table entry, which
 482           correctly pointed to port 1, with one that incorrectly points to port
 483           2.  Afterward, the physical switch will direct packets destined for
 484           the end host to the Open vSwitch on port 2, instead of to the end
 485           host on port 1, disrupting connectivity.  If mirroring to a VLAN is
 486           desired in this scenario, then the physical switch must be replaced
 487           by one that learns Ethernet addresses on a per-VLAN basis.  In
 488           addition, learning should be disabled on the VLAN containing mirrored
 489           traffic. If this is not done then intermediate switches will learn
 490           the MAC address of each end host from the mirrored traffic.  If
 491           packets being sent to that end host are also mirrored, then they will
 492           be dropped since the switch will attempt to send them out the input
 493           port. Disabling learning for the VLAN will cause the switch to
 494           correctly send the packet out all ports configured for that VLAN.  If
 495           Open vSwitch is being used as an intermediate switch, learning can be
 496           disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
 497           in the appropriate <ref table="Bridge"/> table or tables.</p>
 498       </column>
 499     </group>
 500   </table>
 501
 502   <table name="Controller" title="OpenFlow controller configuration.">
 503     An OpenFlow controller.
 504
 505     <group title="Core Features">
 506       <column name="target">
 507         Connection method for controller.
 508         The following connection methods are currently
 509         supported:
 510         <dl>
 511           <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
 512           <dd>
 513             <p>The specified SSL <var>port</var> (default: 6633) on the host at
 514               the given <var>ip</var>, which must be expressed as an IP address
 515               (not a DNS name).  The <ref table="Open_vSwitch" column="ssl"/>
 516               column in the <ref table="Open_vSwitch"/> must point to a valid
 517               SSL configuration when this form is used.</p>
 518             <p>SSL support is an optional feature that is not always built as
 519               part of Open vSwitch.</p>
 520           </dd>
 521           <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
 522           <dd>The specified TCP <var>port</var> (default: 6633) on the host at
 523             the given <var>ip</var>, which must be expressed as an IP address
 524             (not a DNS name).</dd>
 525           <dt><code>discover</code></dt>
 526           <dd>Enables controller discovery.</dd>
 527           <dt><code>none</code></dt>
 528           <dd>Disables the controller.</dd>
 529         </dl>
 530       </column>
 531
 532       <column name="connection_mode">
 533         Either <code>in-band</code> or <code>out-of-band</code>.  If not
 534         specified, the default is implementation-specific.
 535       </column>
 536     </group>
 537
 538     <group title="Controller Failure Detection and Handling">
 539       <column name="max_backoff">
 540         Maximum number of milliseconds to wait between connection attempts.
 541         Default is implementation-specific.
 542       </column>
 543
 544       <column name="inactivity_probe">
 545         Maximum number of milliseconds of idle time on connection to
 546         controller before sending an inactivity probe message.  If Open
 547         vSwitch does not communicate with the controller for the specified
 548         number of seconds, it will send a probe.  If a response is not
 549         received for the same additional amount of time, Open vSwitch
 550         assumes the connection has been broken and attempts to reconnect.
 551         Default is implementation-specific.
 552       </column>
 553
 554       <column name="fail_mode">
 555         <p>When a controller is configured, it is, ordinarily, responsible
 556           for setting up all flows on the switch.  Thus, if the connection to
 557           the controller fails, no new network connections can be set up.
 558           If the connection to the controller stays down long enough,
 559           no packets can pass through the switch at all.  This setting
 560           determines the switch's response to such a situation.  It may be set
 561           to one of the following:
 562           <dl>
 563             <dt><code>standalone</code></dt>
 564             <dd>If no message is received from the controller for three
 565               times the inactivity probe interval
 566               (see <ref column="inactivity_probe"/>), then Open vSwitch
 567               will take over responsibility for setting up flows.  In
 568               this mode, Open vSwitch causes the datapath to act like an
 569               ordinary MAC-learning switch.  Open vSwitch will continue
 570               to retry connecting to the controller in the background
 571               and, when the connection succeeds, it will discontinue its
 572               standalone behavior.</dd>
 573             <dt><code>secure</code></dt>
 574             <dd>Open vSwitch will not set up flows on its own when the
 575               controller connection fails.  It will continue retry
 576               connecting to the controller forever.</dd>
 577           </dl>
 578         </p>
 579         <p>If this value is unset, the default is
 580         implementation-specific.</p>
 581       </column>
 582     </group>
 583
 584     <group title="OpenFlow Rate Limiting">
 585         <column name="controller_burst_limit">
 586           In conjunction with <ref column="controller_rate_limit"/>,
 587           the maximum number of unused packet credits that the bridge will
 588           allow to accumulate, in packets.  If not specified, the default
 589           is implementation-specific.
 590         </column>
 591
 592         <column name="controller_rate_limit">
 593           <p>The maximum rate at which packets in unknown flows will be
 594             forwarded to the OpenFlow controller, in packets per second.  This
 595             feature prevents a single bridge from overwhelming the controller.
 596             If not specified, the default is implementation-specific.</p>
 597           <p>In addition, when a high rate triggers rate-limiting, Open
 598             vSwitch queues controller packets for each port and transmits
 599             them to the controller at the configured rate.  The number of
 600             queued packets is limited by
 601             the <ref column="controller_burst_limit"/> value.  The packet
 602             queue is shared fairly among the ports on a bridge.</p><p>Open
 603             vSwitch maintains two such packet rate-limiters per bridge.
 604             One of these applies to packets sent up to the controller
 605             because they do not correspond to any flow.  The other applies
 606             to packets sent up to the controller by request through flow
 607             actions. When both rate-limiters are filled with packets, the
 608             actual rate that packets are sent to the controller is up to
 609             twice the specified rate.</p>
 610         </column>
 611     </group>
 612
 613     <group title="Additional Configuration for Discovery">
 614       <column name="discover_accept_regex">
 615         If <ref column="target"/> is <code>discover</code>, a POSIX
 616         extended regular expression against which the discovered controller
 617         location is validated.  The regular expression is implicitly
 618         anchored at the beginning of the controller location string, as
 619         if it begins with <code>^</code>.  If not specified, the default
 620         is implementation-specific.
 621       </column>
 622
 623       <column name="discover_update_resolv_conf">
 624         If <ref column="target"/> is <code>discover</code>,
 625         whether to update <code>/etc/resolv.conf</code> when the
 626         controller is discovered.  If not specified, the default
 627         is implementation-specific.  Open vSwitch will only modify
 628         <code>/etc/resolv.conf</code> if the DHCP response that it receives
 629         specifies one or more DNS servers.
 630       </column>
 631     </group>
 632
 633     <group title="Additional Configuration without Discovery">
 634       <column name="local_gateway">
 635         If <ref column="target"/> is not <code>discover</code>, the IP
 636         address of the gateway to configure on the local port.
 637       </column>
 638
 639       <column name="local_ip">
 640         If <ref column="target"/> is not <code>discover</code>, the IP
 641         address to configure on the local port.
 642       </column>
 643
 644       <column name="local_netmask">
 645         If <ref column="target"/> is not <code>discover</code>, the IP
 646         netmask to configure on the local port.
 647       </column>
 648     </group>
 649   </table>
 650
 651   <table name="NetFlow">
 652     A NetFlow target.  NetFlow is a protocol that exports a number of
 653     details about terminating IP flows, such as the principals involved
 654     and duration.
 655
 656     <column name="targets">
 657       NetFlow targets in the form
 658       <code><var>ip</var>:<var>port</var></code>.  The <var>ip</var>
 659       must be specified numerically, not as a DNS name.
 660     </column>
 661
 662     <column name="engine_id">
 663       Engine ID to use in NetFlow messages.  Defaults to datapath index
 664       if not specified.
 665     </column>
 666
 667     <column name="engine_type">
 668       Engine type to use in NetFlow messages.  Defaults to datapath
 669       index if not specified.
 670     </column>
 671
 672     <column name="active_timeout">
 673       The interval at which NetFlow records are sent for flows that are
 674       still active, in seconds.  A value of <code>0</code> requests the
 675       default timeout (currently 600 seconds); a value of <code>-1</code>
 676       disables active timeouts.
 677     </column>
 678
 679     <column name="add_id_to_interface">
 680       <p>If this column's value is <code>false</code>, the ingress and egress
 681         interface fields of NetFlow flow records are derived from OpenFlow port
 682         numbers.  When it is <code>true</code>, the 7 most significant bits of
 683         these fields will be replaced by the least significant 7 bits of the
 684         engine id.  This is useful because many NetFlow collectors do not
 685         expect multiple switches to be sending messages from the same host, so
 686         they do not store the engine information which could be used to
 687         disambiguate the traffic.</p>
 688       <p>When this option is enabled, a maximum of 508 ports are supported.</p>
 689     </column>
 690   </table>
 691
 692   <table name="SSL">
 693     SSL configuration for an Open_vSwitch.
 694
 695     <column name="private_key">
 696       Name of a PEM file containing the private key used as the switch's
 697       identity for SSL connections to the controller.
 698     </column>
 699
 700     <column name="certificate">
 701       Name of a PEM file containing a certificate, signed by the
 702       certificate authority (CA) used by the controller and manager,
 703       that certifies the switch's private key, identifying a trustworthy
 704       switch.
 705     </column>
 706
 707     <column name="ca_cert">
 708       Name of a PEM file containing the CA certificate used to verify
 709       that the switch is connected to a trustworthy controller.
 710     </column>
 711
 712     <column name="bootstrap_ca_cert">
 713       If set to <code>true</code>, then Open vSwitch will attempt to
 714       obtain the CA certificate from the controller on its first SSL
 715       connection and save it to the named PEM file. If it is successful,
 716       it will immediately drop the connection and reconnect, and from then
 717       on all SSL connections must be authenticated by a certificate signed
 718       by the CA certificate thus obtained.  <em>This option exposes the
 719         SSL connection to a man-in-the-middle attack obtaining the initial
 720         CA certificate.</em>  It may still be useful for bootstrapping.
 721     </column>
 722   </table>
 723
 724   <table name="sFlow">
 725     <p>An sFlow(R) target.  sFlow is a protocol for remote monitoring
 726       of switches.</p>
 727
 728     <column name="agent">
 729       IP address to report as ``agent address'' to collectors.  If not
 730       specified, defaults to the <ref table="Controller" column="local_ip"/> in
 731       the collector's <ref table="Controller"/>.  If neither is specified,
 732       sFlow is disabled.
 733     </column>
 734
 735     <column name="header">
 736       Number of bytes of a sampled packet to send to the collector.
 737       If not specified, the default is 128 bytes.
 738     </column>
 739
 740     <column name="polling">
 741       Polling rate in seconds to send port statistics to the collector.
 742       If not specified, defaults to 30 seconds.
 743     </column>
 744
 745     <column name="sampling">
 746       Rate at which packets should be sampled and sent to the collector.
 747       If not specified, defaults to 400, which means one out of 400
 748       packets, on average, will be sent to the collector.
 749     </column>
 750
 751     <column name="targets">
 752       sFlow targets in the form
 753       <code><var>ip</var>:<var>port</var></code>.
 754     </column>
 755   </table>
 756 </database>