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