1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="disable-in-band"
443 type='{"type": "boolean"}'>
444 If set to <code>true</code>, disable in-band control on the bridge
445 regardless of controller and manager settings.
448 <column name="other_config" key="in-band-queue"
449 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
450 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
451 that will be used by flows set up by in-band control on this bridge.
452 If unset, or if the port used by an in-band control flow does not have
453 QoS configured, or if the port does not have a queue with the specified
454 ID, the default queue is used instead.
458 <group title="Spanning Tree Configuration">
459 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
460 that ensures loop-free topologies. It allows redundant links to
461 be included in the network to provide automatic backup paths if
462 the active links fails.
464 <column name="stp_enable">
465 Enable spanning tree on the bridge. By default, STP is disabled
466 on bridges. Bond, internal, and mirror ports are not supported
467 and will not participate in the spanning tree.
470 <column name="other_config" key="stp-system-id">
471 The bridge's STP identifier (the lower 48 bits of the bridge-id)
473 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
474 By default, the identifier is the MAC address of the bridge.
477 <column name="other_config" key="stp-priority"
478 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
479 The bridge's relative priority value for determining the root
480 bridge (the upper 16 bits of the bridge-id). A bridge with the
481 lowest bridge-id is elected the root. By default, the priority
485 <column name="other_config" key="stp-hello-time"
486 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
487 The interval between transmissions of hello messages by
488 designated ports, in seconds. By default the hello interval is
492 <column name="other_config" key="stp-max-age"
493 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
494 The maximum age of the information transmitted by the bridge
495 when it is the root bridge, in seconds. By default, the maximum
499 <column name="other_config" key="stp-forward-delay"
500 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
501 The delay to wait between transitioning root and designated
502 ports to <code>forwarding</code>, in seconds. By default, the
503 forwarding delay is 15 seconds.
507 <group title="Other Features">
508 <column name="datapath_type">
509 Name of datapath provider. The kernel datapath has
510 type <code>system</code>. The userspace datapath has
511 type <code>netdev</code>.
514 <column name="external_ids" key="bridge-id">
515 A unique identifier of the bridge. On Citrix XenServer this will
516 commonly be the same as
517 <ref column="external_ids" key="xs-network-uuids"/>.
520 <column name="external_ids" key="xs-network-uuids">
521 Semicolon-delimited set of universally unique identifier(s) for the
522 network with which this bridge is associated on a Citrix XenServer
523 host. The network identifiers are RFC 4122 UUIDs as displayed by,
524 e.g., <code>xe network-list</code>.
527 <column name="other_config" key="hwaddr">
528 An Ethernet address in the form
529 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
530 to set the hardware address of the local port and influence the
534 <column name="other_config" key="flow-eviction-threshold"
535 type='{"type": "integer", "minInteger": 0}'>
537 A number of flows as a nonnegative integer. This sets number of
538 flows at which eviction from the kernel flow table will be triggered.
539 If there are a large number of flows then increasing this value to
540 around the number of flows present can result in reduced CPU usage
544 The default is 1000. Values below 100 will be rounded up to 100.
548 <column name="other_config" key="forward-bpdu"
549 type='{"type": "boolean"}'>
550 Option to allow forwarding of BPDU frames when NORMAL action is
551 invoked. Frames with reserved Ethernet addresses (e.g. STP
552 BPDU) will be forwarded when this option is enabled and the
553 switch is not providing that functionality. If STP is enabled
554 on the port, STP BPDUs will never be forwarded. If the Open
555 vSwitch bridge is used to connect different Ethernet networks,
556 and if Open vSwitch node does not run STP, then this option
557 should be enabled. Default is disabled, set to
558 <code>true</code> to enable.
560 The following destination MAC addresss will not be forwarded when this
563 <dt><code>01:80:c2:00:00:00</code></dt>
564 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
566 <dt><code>01:80:c2:00:00:01</code></dt>
567 <dd>IEEE Pause frame.</dd>
569 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
570 <dd>Other reserved protocols.</dd>
572 <dt><code>00:e0:2b:00:00:00</code></dt>
573 <dd>Extreme Discovery Protocol (EDP).</dd>
576 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
578 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
580 <dt><code>01:00:0c:cc:cc:cc</code></dt>
582 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
583 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
587 <dt><code>01:00:0c:cc:cc:cd</code></dt>
588 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
590 <dt><code>01:00:0c:cd:cd:cd</code></dt>
591 <dd>Cisco STP Uplink Fast.</dd>
593 <dt><code>01:00:0c:00:00:00</code></dt>
594 <dd>Cisco Inter Switch Link.</dd>
596 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
601 <column name="other_config" key="mac-aging-time"
602 type='{"type": "integer", "minInteger": 1}'>
604 The maximum number of seconds to retain a MAC learning entry for
605 which no packets have been seen. The default is currently 300
606 seconds (5 minutes). The value, if specified, is forced into a
607 reasonable range, currently 15 to 3600 seconds.
611 A short MAC aging time allows a network to more quickly detect that a
612 host is no longer connected to a switch port. However, it also makes
613 it more likely that packets will be flooded unnecessarily, when they
614 are addressed to a connected host that rarely transmits packets. To
615 reduce the incidence of unnecessary flooding, use a MAC aging time
616 longer than the maximum interval at which a host will ordinarily
622 <group title="Bridge Status">
624 Status information about bridges.
626 <column name="status">
627 Key-value pairs that report bridge status.
629 <column name="status" key="stp_bridge_id">
631 The bridge-id (in hex) used in spanning tree advertisements.
632 Configuring the bridge-id is described in the
633 <code>stp-system-id</code> and <code>stp-priority</code> keys
634 of the <code>other_config</code> section earlier.
637 <column name="status" key="stp_designated_root">
639 The designated root (in hex) for this spanning tree.
642 <column name="status" key="stp_root_path_cost">
644 The path cost of reaching the designated bridge. A lower
650 <group title="Common Columns">
651 The overall purpose of these columns is described under <code>Common
652 Columns</code> at the beginning of this document.
654 <column name="other_config"/>
655 <column name="external_ids"/>
659 <table name="Port" table="Port or bond configuration.">
660 <p>A port within a <ref table="Bridge"/>.</p>
661 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
662 <ref column="interfaces"/> column. Such a port logically
663 corresponds to a port on a physical Ethernet switch. A port
664 with more than one interface is a ``bonded port'' (see
665 <ref group="Bonding Configuration"/>).</p>
666 <p>Some properties that one might think as belonging to a port are actually
667 part of the port's <ref table="Interface"/> members.</p>
670 Port name. Should be alphanumeric and no more than about 8
671 bytes long. May be the same as the interface name, for
672 non-bonded ports. Must otherwise be unique among the names of
673 ports, interfaces, and bridges on a host.
676 <column name="interfaces">
677 The port's interfaces. If there is more than one, this is a
681 <group title="VLAN Configuration">
682 <p>Bridge ports support the following types of VLAN configuration:</p>
687 A trunk port carries packets on one or more specified VLANs
688 specified in the <ref column="trunks"/> column (often, on every
689 VLAN). A packet that ingresses on a trunk port is in the VLAN
690 specified in its 802.1Q header, or VLAN 0 if the packet has no
691 802.1Q header. A packet that egresses through a trunk port will
692 have an 802.1Q header if it has a nonzero VLAN ID.
696 Any packet that ingresses on a trunk port tagged with a VLAN that
697 the port does not trunk is dropped.
704 An access port carries packets on exactly one VLAN specified in the
705 <ref column="tag"/> column. Packets egressing on an access port
706 have no 802.1Q header.
710 Any packet with an 802.1Q header with a nonzero VLAN ID that
711 ingresses on an access port is dropped, regardless of whether the
712 VLAN ID in the header is the access port's VLAN ID.
716 <dt>native-tagged</dt>
718 A native-tagged port resembles a trunk port, with the exception that
719 a packet without an 802.1Q header that ingresses on a native-tagged
720 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
724 <dt>native-untagged</dt>
726 A native-untagged port resembles a native-tagged port, with the
727 exception that a packet that egresses on a native-untagged port in
728 the native VLAN will not have an 802.1Q header.
732 A packet will only egress through bridge ports that carry the VLAN of
733 the packet, as described by the rules above.
736 <column name="vlan_mode">
738 The VLAN mode of the port, as described above. When this column is
739 empty, a default mode is selected as follows:
743 If <ref column="tag"/> contains a value, the port is an access
744 port. The <ref column="trunks"/> column should be empty.
747 Otherwise, the port is a trunk port. The <ref column="trunks"/>
748 column value is honored if it is present.
755 For an access port, the port's implicitly tagged VLAN. For a
756 native-tagged or native-untagged port, the port's native VLAN. Must
757 be empty if this is a trunk port.
761 <column name="trunks">
763 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
764 or VLANs that this port trunks; if it is empty, then the port trunks
765 all VLANs. Must be empty if this is an access port.
768 A native-tagged or native-untagged port always trunks its native
769 VLAN, regardless of whether <ref column="trunks"/> includes that
774 <column name="other_config" key="priority-tags"
775 type='{"type": "boolean"}'>
777 An 802.1Q header contains two important pieces of information: a VLAN
778 ID and a priority. A frame with a zero VLAN ID, called a
779 ``priority-tagged'' frame, is supposed to be treated the same way as
780 a frame without an 802.1Q header at all (except for the priority).
784 However, some network elements ignore any frame that has 802.1Q
785 header at all, even when the VLAN ID is zero. Therefore, by default
786 Open vSwitch does not output priority-tagged frames, instead omitting
787 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
788 <code>true</code> to enable priority-tagged frames on a port.
792 Regardless of this setting, Open vSwitch omits the 802.1Q header on
793 output if both the VLAN ID and priority would be zero.
797 All frames output to native-tagged ports have a nonzero VLAN ID, so
798 this setting is not meaningful on native-tagged ports.
803 <group title="Bonding Configuration">
804 <p>A port that has more than one interface is a ``bonded port.'' Bonding
805 allows for load balancing and fail-over. Some kinds of bonding will
806 work with any kind of upstream switch:</p>
809 <dt><code>balance-slb</code></dt>
811 Balances flows among slaves based on source MAC address and output
812 VLAN, with periodic rebalancing as traffic patterns change.
815 <dt><code>active-backup</code></dt>
817 Assigns all flows to one slave, failing over to a backup slave when
818 the active slave is disabled.
823 The following modes require the upstream switch to support 802.3ad with
824 successful LACP negotiation:
828 <dt><code>balance-tcp</code></dt>
830 Balances flows among slaves based on L2, L3, and L4 protocol
831 information such as destination MAC address, IP address, and TCP
835 <dt><code>stable</code></dt>
837 <p>Attempts to always assign a given flow to the same slave
838 consistently. In an effort to maintain stability, no load
839 balancing is done. Uses a similar hashing strategy to
840 <code>balance-tcp</code>, always taking into account L3 and L4
841 fields even if LACP negotiations are unsuccessful. </p>
842 <p>Slave selection decisions are made based on <ref table="Interface"
843 column="other_config" key="bond-stable-id"/> if set. Otherwise,
844 OpenFlow port number is used. Decisions are consistent across all
845 <code>ovs-vswitchd</code> instances with equivalent
846 <ref table="Interface" column="other_config" key="bond-stable-id"/>
851 <p>These columns apply only to bonded ports. Their values are
852 otherwise ignored.</p>
854 <column name="bond_mode">
855 <p>The type of bonding used for a bonded port. Defaults to
856 <code>active-backup</code> if unset.
860 <column name="other_config" key="bond-hash-basis"
861 type='{"type": "integer"}'>
862 An integer hashed along with flows when choosing output slaves in load
863 balanced bonds. When changed, all flows will be assigned different
864 hash values possibly causing slave selection decisions to change. Does
865 not affect bonding modes which do not employ load balancing such as
866 <code>active-backup</code>.
869 <group title="Link Failure Detection">
871 An important part of link bonding is detecting that links are down so
872 that they may be disabled. These settings determine how Open vSwitch
873 detects link failure.
876 <column name="other_config" key="bond-detect-mode"
877 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
878 The means used to detect link failures. Defaults to
879 <code>carrier</code> which uses each interface's carrier to detect
880 failures. When set to <code>miimon</code>, will check for failures
881 by polling each interface's MII.
884 <column name="other_config" key="bond-miimon-interval"
885 type='{"type": "integer"}'>
886 The interval, in milliseconds, between successive attempts to poll
887 each interface's MII. Relevant only when <ref column="other_config"
888 key="bond-detect-mode"/> is <code>miimon</code>.
891 <column name="bond_updelay">
893 The number of milliseconds for which carrier must stay up on an
894 interface before the interface is considered to be up. Specify
895 <code>0</code> to enable the interface immediately.
899 This setting is honored only when at least one bonded interface is
900 already enabled. When no interfaces are enabled, then the first
901 bond interface to come up is enabled immediately.
905 <column name="bond_downdelay">
906 The number of milliseconds for which carrier must stay down on an
907 interface before the interface is considered to be down. Specify
908 <code>0</code> to disable the interface immediately.
912 <group title="LACP Configuration">
914 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
915 allows switches to automatically detect that they are connected by
916 multiple links and aggregate across those links. These settings
917 control LACP behavior.
921 Configures LACP on this port. LACP allows directly connected
922 switches to negotiate which links may be bonded. LACP may be enabled
923 on non-bonded ports for the benefit of any switches they may be
924 connected to. <code>active</code> ports are allowed to initiate LACP
925 negotiations. <code>passive</code> ports are allowed to participate
926 in LACP negotiations initiated by a remote switch, but not allowed to
927 initiate such negotiations themselves. If LACP is enabled on a port
928 whose partner switch does not support LACP, the bond will be
929 disabled. Defaults to <code>off</code> if unset.
932 <column name="other_config" key="lacp-system-id">
933 The LACP system ID of this <ref table="Port"/>. The system ID of a
934 LACP bond is used to identify itself to its partners. Must be a
935 nonzero MAC address. Defaults to the bridge Ethernet address if
939 <column name="other_config" key="lacp-system-priority"
940 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
941 The LACP system priority of this <ref table="Port"/>. In LACP
942 negotiations, link status decisions are made by the system with the
943 numerically lower priority.
946 <column name="other_config" key="lacp-time"
947 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
949 The LACP timing which should be used on this <ref table="Port"/>.
950 By default <code>slow</code> is used. When configured to be
951 <code>fast</code> LACP heartbeats are requested at a rate of once
952 per second causing connectivity problems to be detected more
953 quickly. In <code>slow</code> mode, heartbeats are requested at a
954 rate of once every 30 seconds.
959 <group title="SLB Configuration">
961 These settings control behavior when a bond is in
962 <code>balance-slb</code> mode, regardless of whether the bond was
963 intentionally configured in SLB mode or it fell back to SLB mode
964 because LACP negotiation failed.
967 <column name="other_config" key="bond-rebalance-interval"
968 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
969 For a load balanced bonded port, the number of milliseconds between
970 successive attempts to rebalance the bond, that is, to move flows
971 from one interface on the bond to another in an attempt to keep usage
972 of each interface roughly equal. If zero, load balancing is disabled
973 on the bond (carrier status changes still cause flows to move). If
974 less than 1000ms, the rebalance interval will be 1000ms.
978 <column name="bond_fake_iface">
979 For a bonded port, whether to create a fake internal interface with the
980 name of the port. Use only for compatibility with legacy software that
985 <group title="Spanning Tree Configuration">
986 <column name="other_config" key="stp-enable"
987 type='{"type": "boolean"}'>
988 If spanning tree is enabled on the bridge, member ports are
989 enabled by default (with the exception of bond, internal, and
990 mirror ports which do not work with STP). If this column's
991 value is <code>false</code> spanning tree is disabled on the
995 <column name="other_config" key="stp-port-num"
996 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
997 The port number used for the lower 8 bits of the port-id. By
998 default, the numbers will be assigned automatically. If any
999 port's number is manually configured on a bridge, then they
1003 <column name="other_config" key="stp-port-priority"
1004 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1005 The port's relative priority value for determining the root
1006 port (the upper 8 bits of the port-id). A port with a lower
1007 port-id will be chosen as the root port. By default, the
1011 <column name="other_config" key="stp-path-cost"
1012 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1013 Spanning tree path cost for the port. A lower number indicates
1014 a faster link. By default, the cost is based on the maximum
1019 <group title="Other Features">
1021 Quality of Service configuration for this port.
1025 The MAC address to use for this port for the purpose of choosing the
1026 bridge's MAC address. This column does not necessarily reflect the
1027 port's actual MAC address, nor will setting it change the port's actual
1031 <column name="fake_bridge">
1032 Does this port represent a sub-bridge for its tagged VLAN within the
1033 Bridge? See ovs-vsctl(8) for more information.
1036 <column name="external_ids" key="fake-bridge-id-*">
1037 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1038 column) are defined by prefixing a <ref table="Bridge"/> <ref
1039 table="Bridge" column="external_ids"/> key with
1040 <code>fake-bridge-</code>,
1041 e.g. <code>fake-bridge-xs-network-uuids</code>.
1045 <group title="Port Status">
1047 Status information about ports attached to bridges.
1049 <column name="status">
1050 Key-value pairs that report port status.
1052 <column name="status" key="stp_port_id">
1054 The port-id (in hex) used in spanning tree advertisements for
1055 this port. Configuring the port-id is described in the
1056 <code>stp-port-num</code> and <code>stp-port-priority</code>
1057 keys of the <code>other_config</code> section earlier.
1060 <column name="status" key="stp_state"
1061 type='{"type": "string", "enum": ["set",
1062 ["disabled", "listening", "learning",
1063 "forwarding", "blocking"]]}'>
1065 STP state of the port.
1068 <column name="status" key="stp_sec_in_state"
1069 type='{"type": "integer", "minInteger": 0}'>
1071 The amount of time (in seconds) port has been in the current
1075 <column name="status" key="stp_role"
1076 type='{"type": "string", "enum": ["set",
1077 ["root", "designated", "alternate"]]}'>
1079 STP role of the port.
1084 <group title="Port Statistics">
1086 Key-value pairs that report port statistics.
1088 <group title="Statistics: STP transmit and receive counters">
1089 <column name="statistics" key="stp_tx_count">
1090 Number of STP BPDUs sent on this port by the spanning
1093 <column name="statistics" key="stp_rx_count">
1094 Number of STP BPDUs received on this port and accepted by the
1095 spanning tree library.
1097 <column name="statistics" key="stp_error_count">
1098 Number of bad STP BPDUs received on this port. Bad BPDUs
1099 include runt packets and those with an unexpected protocol ID.
1104 <group title="Common Columns">
1105 The overall purpose of these columns is described under <code>Common
1106 Columns</code> at the beginning of this document.
1108 <column name="other_config"/>
1109 <column name="external_ids"/>
1113 <table name="Interface" title="One physical network device in a Port.">
1114 An interface within a <ref table="Port"/>.
1116 <group title="Core Features">
1117 <column name="name">
1118 Interface name. Should be alphanumeric and no more than about 8 bytes
1119 long. May be the same as the port name, for non-bonded ports. Must
1120 otherwise be unique among the names of ports, interfaces, and bridges
1125 <p>Ethernet address to set for this interface. If unset then the
1126 default MAC address is used:</p>
1128 <li>For the local interface, the default is the lowest-numbered MAC
1129 address among the other bridge ports, either the value of the
1130 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1131 if set, or its actual MAC (for bonded ports, the MAC of its slave
1132 whose name is first in alphabetical order). Internal ports and
1133 bridge ports that are used as port mirroring destinations (see the
1134 <ref table="Mirror"/> table) are ignored.</li>
1135 <li>For other internal interfaces, the default MAC is randomly
1137 <li>External interfaces typically have a MAC address associated with
1138 their hardware.</li>
1140 <p>Some interfaces may not have a software-controllable MAC
1144 <column name="ofport">
1145 <p>OpenFlow port number for this interface. Unlike most columns, this
1146 column's value should be set only by Open vSwitch itself. Other
1147 clients should set this column to an empty set (the default) when
1148 creating an <ref table="Interface"/>.</p>
1149 <p>Open vSwitch populates this column when the port number becomes
1150 known. If the interface is successfully added,
1151 <ref column="ofport"/> will be set to a number between 1 and 65535
1152 (generally either in the range 1 to 65279, inclusive, or 65534, the
1153 port number for the OpenFlow ``local port''). If the interface
1154 cannot be added then Open vSwitch sets this column
1159 <group title="System-Specific Details">
1160 <column name="type">
1162 The interface type, one of:
1166 <dt><code>system</code></dt>
1167 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1168 Sometimes referred to as ``external interfaces'' since they are
1169 generally connected to hardware external to that on which the Open
1170 vSwitch is running. The empty string is a synonym for
1171 <code>system</code>.</dd>
1173 <dt><code>internal</code></dt>
1174 <dd>A simulated network device that sends and receives traffic. An
1175 internal interface whose <ref column="name"/> is the same as its
1176 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1177 ``local interface.'' It does not make sense to bond an internal
1178 interface, so the terms ``port'' and ``interface'' are often used
1179 imprecisely for internal interfaces.</dd>
1181 <dt><code>tap</code></dt>
1182 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1184 <dt><code>gre</code></dt>
1186 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1187 tunnel. See <ref group="Tunnel Options"/> for information on
1188 configuring GRE tunnels.
1191 <dt><code>ipsec_gre</code></dt>
1193 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1197 <dt><code>capwap</code></dt>
1199 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1200 5415). This allows interoperability with certain switches that do
1201 not support GRE. Only the tunneling component of the protocol is
1202 implemented. UDP ports 58881 and 58882 are used as the source and
1203 destination ports respectively. CAPWAP is currently supported only
1204 with the Linux kernel datapath with kernel version 2.6.26 or later.
1207 <dt><code>patch</code></dt>
1209 A pair of virtual devices that act as a patch cable.
1212 <dt><code>null</code></dt>
1213 <dd>An ignored interface.</dd>
1218 <group title="Tunnel Options">
1220 These options apply to interfaces with <ref column="type"/> of
1221 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1225 Each tunnel must be uniquely identified by the combination of <ref
1226 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1227 column="options" key="local_ip"/>, and <ref column="options"
1228 key="in_key"/>. If two ports are defined that are the same except one
1229 has an optional identifier and the other does not, the more specific
1230 one is matched first. <ref column="options" key="in_key"/> is
1231 considered more specific than <ref column="options" key="local_ip"/> if
1232 a port defines one and another port defines the other.
1235 <column name="options" key="remote_ip">
1237 Required. The tunnel endpoint. Unicast and multicast endpoints are
1242 When a multicast endpoint is specified, a routing table lookup occurs
1243 only when the tunnel is created. Following a routing change, delete
1244 and then re-create the tunnel to force a new routing table lookup.
1248 <column name="options" key="local_ip">
1249 Optional. The destination IP that received packets must match.
1250 Default is to match all addresses. Must be omitted when <ref
1251 column="options" key="remote_ip"/> is a multicast address.
1254 <column name="options" key="in_key">
1255 <p>Optional. The key that received packets must contain, one of:</p>
1259 <code>0</code>. The tunnel receives packets with no key or with a
1260 key of 0. This is equivalent to specifying no <ref column="options"
1261 key="in_key"/> at all.
1264 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1265 tunnel receives only packets with the specified key.
1268 The word <code>flow</code>. The tunnel accepts packets with any
1269 key. The key will be placed in the <code>tun_id</code> field for
1270 matching in the flow table. The <code>ovs-ofctl</code> manual page
1271 contains additional information about matching fields in OpenFlow
1280 <column name="options" key="out_key">
1281 <p>Optional. The key to be set on outgoing packets, one of:</p>
1285 <code>0</code>. Packets sent through the tunnel will have no key.
1286 This is equivalent to specifying no <ref column="options"
1287 key="out_key"/> at all.
1290 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1291 sent through the tunnel will have the specified key.
1294 The word <code>flow</code>. Packets sent through the tunnel will
1295 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1296 vendor extension (0 is used in the absence of an action). The
1297 <code>ovs-ofctl</code> manual page contains additional information
1298 about the Nicira OpenFlow vendor extensions.
1303 <column name="options" key="key">
1304 Optional. Shorthand to set <code>in_key</code> and
1305 <code>out_key</code> at the same time.
1308 <column name="options" key="tos">
1309 Optional. The value of the ToS bits to be set on the encapsulating
1310 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1311 zero. It may also be the word <code>inherit</code>, in which case
1312 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1313 (otherwise it will be 0). The ECN fields are always inherited.
1317 <column name="options" key="ttl">
1318 Optional. The TTL to be set on the encapsulating packet. It may also
1319 be the word <code>inherit</code>, in which case the TTL will be copied
1320 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1321 system default, typically 64). Default is the system default TTL.
1324 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1325 Optional. If enabled, the Don't Fragment bit will be copied from the
1326 inner IP headers (those of the encapsulated traffic) to the outer
1327 (tunnel) headers. Default is disabled; set to <code>true</code> to
1331 <column name="options" key="df_default"
1332 type='{"type": "boolean"}'>
1333 Optional. If enabled, the Don't Fragment bit will be set by default on
1334 tunnel headers if the <code>df_inherit</code> option is not set, or if
1335 the encapsulated packet is not IP. Default is enabled; set to
1336 <code>false</code> to disable.
1339 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1340 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1341 Destination Unreachable - Fragmentation Needed'' messages will be
1342 generated for IPv4 packets with the DF bit set and IPv6 packets above
1343 the minimum MTU if the packet size exceeds the path MTU minus the size
1344 of the tunnel headers. Note that this option causes behavior that is
1345 typically reserved for routers and therefore is not entirely in
1346 compliance with the IEEE 802.1D specification for bridges. Default is
1347 enabled; set to <code>false</code> to disable.
1350 <group title="Tunnel Options: gre only">
1352 Only <code>gre</code> interfaces support these options.
1355 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1356 Enable caching of tunnel headers and the output path. This can lead
1357 to a significant performance increase without changing behavior. In
1358 general it should not be necessary to adjust this setting. However,
1359 the caching can bypass certain components of the IP stack (such as
1360 <code>iptables</code>) and it may be useful to disable it if these
1361 features are required or as a debugging measure. Default is enabled,
1362 set to <code>false</code> to disable.
1366 <group title="Tunnel Options: gre and ipsec_gre only">
1368 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1372 <column name="options" key="csum" type='{"type": "boolean"}'>
1374 Optional. Compute GRE checksums on outgoing packets. Default is
1375 disabled, set to <code>true</code> to enable. Checksums present on
1376 incoming packets will be validated regardless of this setting.
1380 GRE checksums impose a significant performance penalty because they
1381 cover the entire packet. The encapsulated L3, L4, and L7 packet
1382 contents typically have their own checksums, so this additional
1383 checksum only adds value for the GRE and encapsulated L2 headers.
1387 This option is supported for <code>ipsec_gre</code>, but not useful
1388 because GRE checksums are weaker than, and redundant with, IPsec
1389 payload authentication.
1394 <group title="Tunnel Options: ipsec_gre only">
1396 Only <code>ipsec_gre</code> interfaces support these options.
1399 <column name="options" key="peer_cert">
1400 Required for certificate authentication. A string containing the
1401 peer's certificate in PEM format. Additionally the host's
1402 certificate must be specified with the <code>certificate</code>
1406 <column name="options" key="certificate">
1407 Required for certificate authentication. The name of a PEM file
1408 containing a certificate that will be presented to the peer during
1412 <column name="options" key="private_key">
1413 Optional for certificate authentication. The name of a PEM file
1414 containing the private key associated with <code>certificate</code>.
1415 If <code>certificate</code> contains the private key, this option may
1419 <column name="options" key="psk">
1420 Required for pre-shared key authentication. Specifies a pre-shared
1421 key for authentication that must be identical on both sides of the
1427 <group title="Patch Options">
1429 Only <code>patch</code> interfaces support these options.
1432 <column name="options" key="peer">
1433 The <ref column="name"/> of the <ref table="Interface"/> for the other
1434 side of the patch. The named <ref table="Interface"/>'s own
1435 <code>peer</code> option must specify this <ref table="Interface"/>'s
1436 name. That is, the two patch interfaces must have reversed <ref
1437 column="name"/> and <code>peer</code> values.
1441 <group title="Interface Status">
1443 Status information about interfaces attached to bridges, updated every
1444 5 seconds. Not all interfaces have all of these properties; virtual
1445 interfaces don't have a link speed, for example. Non-applicable
1446 columns will have empty values.
1448 <column name="admin_state">
1450 The administrative state of the physical network link.
1454 <column name="link_state">
1456 The observed state of the physical network link. This is ordinarily
1457 the link's carrier status. If the interface's <ref table="Port"/> is
1458 a bond configured for miimon monitoring, it is instead the network
1459 link's miimon status.
1463 <column name="link_resets">
1465 The number of times Open vSwitch has observed the
1466 <ref column="link_state"/> of this <ref table="Interface"/> change.
1470 <column name="link_speed">
1472 The negotiated speed of the physical network link.
1473 Valid values are positive integers greater than 0.
1477 <column name="duplex">
1479 The duplex mode of the physical network link.
1485 The MTU (maximum transmission unit); i.e. the largest
1486 amount of data that can fit into a single Ethernet frame.
1487 The standard Ethernet MTU is 1500 bytes. Some physical media
1488 and many kinds of virtual interfaces can be configured with
1492 This column will be empty for an interface that does not
1493 have an MTU as, for example, some kinds of tunnels do not.
1497 <column name="lacp_current">
1498 Boolean value indicating LACP status for this interface. If true, this
1499 interface has current LACP information about its LACP partner. This
1500 information may be used to monitor the health of interfaces in a LACP
1501 enabled port. This column will be empty if LACP is not enabled.
1504 <column name="status">
1505 Key-value pairs that report port status. Supported status values are
1506 <ref column="type"/>-dependent; some interfaces may not have a valid
1507 <ref column="status" key="driver_name"/>, for example.
1510 <column name="status" key="driver_name">
1511 The name of the device driver controlling the network adapter.
1514 <column name="status" key="driver_version">
1515 The version string of the device driver controlling the network
1519 <column name="status" key="firmware_version">
1520 The version string of the network adapter's firmware, if available.
1523 <column name="status" key="source_ip">
1524 The source IP address used for an IPv4 tunnel end-point, such as
1525 <code>gre</code> or <code>capwap</code>.
1528 <column name="status" key="tunnel_egress_iface">
1529 Egress interface for tunnels. Currently only relevant for GRE and
1530 CAPWAP tunnels. On Linux systems, this column will show the name of
1531 the interface which is responsible for routing traffic destined for the
1532 configured <ref column="options" key="remote_ip"/>. This could be an
1533 internal interface such as a bridge port.
1536 <column name="status" key="tunnel_egress_iface_carrier"
1537 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1538 Whether carrier is detected on <ref column="status"
1539 key="tunnel_egress_iface"/>.
1543 <group title="Statistics">
1545 Key-value pairs that report interface statistics. The current
1546 implementation updates these counters periodically. Future
1547 implementations may update them when an interface is created, when they
1548 are queried (e.g. using an OVSDB <code>select</code> operation), and
1549 just before an interface is deleted due to virtual interface hot-unplug
1550 or VM shutdown, and perhaps at other times, but not on any regular
1554 These are the same statistics reported by OpenFlow in its <code>struct
1555 ofp_port_stats</code> structure. If an interface does not support a
1556 given statistic, then that pair is omitted.
1558 <group title="Statistics: Successful transmit and receive counters">
1559 <column name="statistics" key="rx_packets">
1560 Number of received packets.
1562 <column name="statistics" key="rx_bytes">
1563 Number of received bytes.
1565 <column name="statistics" key="tx_packets">
1566 Number of transmitted packets.
1568 <column name="statistics" key="tx_bytes">
1569 Number of transmitted bytes.
1572 <group title="Statistics: Receive errors">
1573 <column name="statistics" key="rx_dropped">
1574 Number of packets dropped by RX.
1576 <column name="statistics" key="rx_frame_err">
1577 Number of frame alignment errors.
1579 <column name="statistics" key="rx_over_err">
1580 Number of packets with RX overrun.
1582 <column name="statistics" key="rx_crc_err">
1583 Number of CRC errors.
1585 <column name="statistics" key="rx_errors">
1586 Total number of receive errors, greater than or equal to the sum of
1590 <group title="Statistics: Transmit errors">
1591 <column name="statistics" key="tx_dropped">
1592 Number of packets dropped by TX.
1594 <column name="statistics" key="collisions">
1595 Number of collisions.
1597 <column name="statistics" key="tx_errors">
1598 Total number of transmit errors, greater than or equal to the sum of
1604 <group title="Ingress Policing">
1606 These settings control ingress policing for packets received on this
1607 interface. On a physical interface, this limits the rate at which
1608 traffic is allowed into the system from the outside; on a virtual
1609 interface (one connected to a virtual machine), this limits the rate at
1610 which the VM is able to transmit.
1613 Policing is a simple form of quality-of-service that simply drops
1614 packets received in excess of the configured rate. Due to its
1615 simplicity, policing is usually less accurate and less effective than
1616 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1617 table="Queue"/> tables).
1620 Policing is currently implemented only on Linux. The Linux
1621 implementation uses a simple ``token bucket'' approach:
1625 The size of the bucket corresponds to <ref
1626 column="ingress_policing_burst"/>. Initially the bucket is full.
1629 Whenever a packet is received, its size (converted to tokens) is
1630 compared to the number of tokens currently in the bucket. If the
1631 required number of tokens are available, they are removed and the
1632 packet is forwarded. Otherwise, the packet is dropped.
1635 Whenever it is not full, the bucket is refilled with tokens at the
1636 rate specified by <ref column="ingress_policing_rate"/>.
1640 Policing interacts badly with some network protocols, and especially
1641 with fragmented IP packets. Suppose that there is enough network
1642 activity to keep the bucket nearly empty all the time. Then this token
1643 bucket algorithm will forward a single packet every so often, with the
1644 period depending on packet size and on the configured rate. All of the
1645 fragments of an IP packets are normally transmitted back-to-back, as a
1646 group. In such a situation, therefore, only one of these fragments
1647 will be forwarded and the rest will be dropped. IP does not provide
1648 any way for the intended recipient to ask for only the remaining
1649 fragments. In such a case there are two likely possibilities for what
1650 will happen next: either all of the fragments will eventually be
1651 retransmitted (as TCP will do), in which case the same problem will
1652 recur, or the sender will not realize that its packet has been dropped
1653 and data will simply be lost (as some UDP-based protocols will do).
1654 Either way, it is possible that no forward progress will ever occur.
1656 <column name="ingress_policing_rate">
1658 Maximum rate for data received on this interface, in kbps. Data
1659 received faster than this rate is dropped. Set to <code>0</code>
1660 (the default) to disable policing.
1664 <column name="ingress_policing_burst">
1665 <p>Maximum burst size for data received on this interface, in kb. The
1666 default burst size if set to <code>0</code> is 1000 kb. This value
1667 has no effect if <ref column="ingress_policing_rate"/>
1668 is <code>0</code>.</p>
1670 Specifying a larger burst size lets the algorithm be more forgiving,
1671 which is important for protocols like TCP that react severely to
1672 dropped packets. The burst size should be at least the size of the
1673 interface's MTU. Specifying a value that is numerically at least as
1674 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1675 closer to achieving the full rate.
1680 <group title="Connectivity Fault Management">
1682 802.1ag Connectivity Fault Management (CFM) allows a group of
1683 Maintenance Points (MPs) called a Maintenance Association (MA) to
1684 detect connectivity problems with each other. MPs within a MA should
1685 have complete and exclusive interconnectivity. This is verified by
1686 occasionally broadcasting Continuity Check Messages (CCMs) at a
1687 configurable transmission interval.
1691 According to the 802.1ag specification, each Maintenance Point should
1692 be configured out-of-band with a list of Remote Maintenance Points it
1693 should have connectivity to. Open vSwitch differs from the
1694 specification in this area. It simply assumes the link is faulted if
1695 no Remote Maintenance Points are reachable, and considers it not
1699 <column name="cfm_mpid">
1700 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1701 a Maintenance Association. The MPID is used to identify this endpoint
1702 to other Maintenance Points in the MA. Each end of a link being
1703 monitored should have a different MPID. Must be configured to enable
1704 CFM on this <ref table="Interface"/>.
1707 <column name="cfm_fault">
1709 Indicates a connectivity fault triggered by an inability to receive
1710 heartbeats from any remote endpoint. When a fault is triggered on
1711 <ref table="Interface"/>s participating in bonds, they will be
1715 Faults can be triggered for several reasons. Most importantly they
1716 are triggered when no CCMs are received for a period of 3.5 times the
1717 transmission interval. Faults are also triggered when any CCMs
1718 indicate that a Remote Maintenance Point is not receiving CCMs but
1719 able to send them. Finally, a fault is triggered if a CCM is
1720 received which indicates unexpected configuration. Notably, this
1721 case arises when a CCM is received which advertises the local MPID.
1725 <column name="cfm_fault_status" key="recv">
1726 Indicates a CFM fault was triggered due to a lack of CCMs received on
1727 the <ref table="Interface"/>.
1730 <column name="cfm_fault_status" key="rdi">
1731 Indicates a CFM fault was triggered due to the reception of a CCM with
1732 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1733 are not receiving CCMs themselves. This typically indicates a
1734 unidirectional connectivity failure.
1737 <column name="cfm_fault_status" key="maid">
1738 Indicates a CFM fault was triggered due to the reception of a CCM with
1739 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1740 with an identification number in addition to the MPID called the MAID.
1741 Open vSwitch only supports receiving CCM broadcasts tagged with the
1742 MAID it uses internally.
1745 <column name="cfm_fault_status" key="loopback">
1746 Indicates a CFM fault was triggered due to the reception of a CCM
1747 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1748 column of this <ref table="Interface"/>. This may indicate a loop in
1752 <column name="cfm_fault_status" key="overflow">
1753 Indicates a CFM fault was triggered because the CFM module received
1754 CCMs from more remote endpoints than it can keep track of.
1757 <column name="cfm_fault_status" key="override">
1758 Indicates a CFM fault was manually triggered by an administrator using
1759 an <code>ovs-appctl</code> command.
1762 <column name="cfm_fault_status" key="interval">
1763 Indicates a CFM fault was triggered due to the reception of a CCM
1764 frame having an invalid interval.
1767 <column name="cfm_health">
1769 Indicates the health of the interface as a percentage of CCM frames
1770 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1771 The health of an interface is undefined if it is communicating with
1772 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1773 healthy heartbeats are not received at the expected rate, and
1774 gradually improves as healthy heartbeats are received at the desired
1775 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1776 health of the interface is refreshed.
1779 As mentioned above, the faults can be triggered for several reasons.
1780 The link health will deteriorate even if heartbeats are received but
1781 they are reported to be unhealthy. An unhealthy heartbeat in this
1782 context is a heartbeat for which either some fault is set or is out
1783 of sequence. The interface health can be 100 only on receiving
1784 healthy heartbeats at the desired rate.
1788 <column name="cfm_remote_mpids">
1789 When CFM is properly configured, Open vSwitch will occasionally
1790 receive CCM broadcasts. These broadcasts contain the MPID of the
1791 sending Maintenance Point. The list of MPIDs from which this
1792 <ref table="Interface"/> is receiving broadcasts from is regularly
1793 collected and written to this column.
1796 <column name="other_config" key="cfm_interval"
1797 type='{"type": "integer"}'>
1799 The interval, in milliseconds, between transmissions of CFM
1800 heartbeats. Three missed heartbeat receptions indicate a
1805 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1806 60,000, or 600,000 ms are supported. Other values will be rounded
1807 down to the nearest value on the list. Extended mode (see <ref
1808 column="other_config" key="cfm_extended"/>) supports any interval up
1809 to 65,535 ms. In either mode, the default is 1000 ms.
1812 <p>We do not recommend using intervals less than 100 ms.</p>
1815 <column name="other_config" key="cfm_extended"
1816 type='{"type": "boolean"}'>
1817 When <code>true</code>, the CFM module operates in extended mode. This
1818 causes it to use a nonstandard destination address to avoid conflicting
1819 with compliant implementations which may be running concurrently on the
1820 network. Furthermore, extended mode increases the accuracy of the
1821 <code>cfm_interval</code> configuration parameter by breaking wire
1822 compatibility with 802.1ag compliant implementations. Defaults to
1825 <column name="other_config" key="cfm_opstate"
1826 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1827 When <code>down</code>, the CFM module marks all CCMs it generates as
1828 operationally down without triggering a fault. This allows remote
1829 maintenance points to choose not to forward traffic to the
1830 <ref table="Interface"/> on which this CFM module is running.
1831 Currently, in Open vSwitch, the opdown bit of CCMs affects
1832 <ref table="Interface"/>s participating in bonds, and the bundle
1833 OpenFlow action. This setting is ignored when CFM is not in extended
1834 mode. Defaults to <code>up</code>.
1837 <column name="other_config" key="cfm_ccm_vlan"
1838 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1839 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1840 with the given value. May be the string <code>random</code> in which
1841 case each CCM will be tagged with a different randomly generated VLAN.
1844 <column name="other_config" key="cfm_ccm_pcp"
1845 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1846 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1847 with the given PCP value. The VLAN ID of the tag is governed by the
1848 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1849 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1855 <group title="Bonding Configuration">
1856 <column name="other_config" key="bond-stable-id"
1857 type='{"type": "integer", "minInteger": 1}'>
1858 Used in <code>stable</code> bond mode to make slave
1859 selection decisions. Allocating <ref column="other_config"
1860 key="bond-stable-id"/> values consistently across interfaces
1861 participating in a bond will guarantee consistent slave selection
1862 decisions across <code>ovs-vswitchd</code> instances when using
1863 <code>stable</code> bonding mode.
1866 <column name="other_config" key="lacp-port-id"
1867 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1868 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1869 used in LACP negotiations to identify individual ports
1870 participating in a bond.
1873 <column name="other_config" key="lacp-port-priority"
1874 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1875 The LACP port priority of this <ref table="Interface"/>. In LACP
1876 negotiations <ref table="Interface"/>s with numerically lower
1877 priorities are preferred for aggregation.
1880 <column name="other_config" key="lacp-aggregation-key"
1881 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1882 The LACP aggregation key of this <ref table="Interface"/>. <ref
1883 table="Interface"/>s with different aggregation keys may not be active
1884 within a given <ref table="Port"/> at the same time.
1888 <group title="Virtual Machine Identifiers">
1890 These key-value pairs specifically apply to an interface that
1891 represents a virtual Ethernet interface connected to a virtual
1892 machine. These key-value pairs should not be present for other types
1893 of interfaces. Keys whose names end in <code>-uuid</code> have
1894 values that uniquely identify the entity in question. For a Citrix
1895 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1896 Other hypervisors may use other formats.
1899 <column name="external_ids" key="attached-mac">
1900 The MAC address programmed into the ``virtual hardware'' for this
1901 interface, in the form
1902 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1903 For Citrix XenServer, this is the value of the <code>MAC</code> field
1904 in the VIF record for this interface.
1907 <column name="external_ids" key="iface-id">
1908 A system-unique identifier for the interface. On XenServer, this will
1909 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1912 <column name="external_ids" key="iface-status"
1913 type='{"type": "string",
1914 "enum": ["set", ["active", "inactive"]]}'>
1916 Hypervisors may sometimes have more than one interface associated
1917 with a given <ref column="external_ids" key="iface-id"/>, only one of
1918 which is actually in use at a given time. For example, in some
1919 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1920 for a single <ref column="external_ids" key="iface-id"/>, but only
1921 uses one of them at a time. A hypervisor that behaves this way must
1922 mark the currently in use interface <code>active</code> and the
1923 others <code>inactive</code>. A hypervisor that never has more than
1924 one interface for a given <ref column="external_ids" key="iface-id"/>
1925 may mark that interface <code>active</code> or omit <ref
1926 column="external_ids" key="iface-status"/> entirely.
1930 During VM migration, a given <ref column="external_ids"
1931 key="iface-id"/> might transiently be marked <code>active</code> on
1932 two different hypervisors. That is, <code>active</code> means that
1933 this <ref column="external_ids" key="iface-id"/> is the active
1934 instance within a single hypervisor, not in a broader scope.
1938 <column name="external_ids" key="xs-vif-uuid">
1939 The virtual interface associated with this interface.
1942 <column name="external_ids" key="xs-network-uuid">
1943 The virtual network to which this interface is attached.
1946 <column name="external_ids" key="vm-id">
1947 The VM to which this interface belongs. On XenServer, this will be the
1948 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1951 <column name="external_ids" key="xs-vm-uuid">
1952 The VM to which this interface belongs.
1956 <group title="VLAN Splinters">
1958 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1959 with buggy network drivers in old versions of Linux that do not
1960 properly support VLANs when VLAN devices are not used, at some cost
1961 in memory and performance.
1965 When VLAN splinters are enabled on a particular interface, Open vSwitch
1966 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1967 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1968 received on the VLAN device is treated as if it had been received on
1969 the interface on the particular VLAN.
1973 VLAN splinters consider a VLAN to be in use if:
1978 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1979 table="Port"/> record.
1983 The VLAN is listed within the <ref table="Port" column="trunks"/>
1984 column of the <ref table="Port"/> record of an interface on which
1985 VLAN splinters are enabled.
1987 An empty <ref table="Port" column="trunks"/> does not influence the
1988 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1989 will exceed the current 1,024 port per datapath limit.
1993 An OpenFlow flow within any bridge matches the VLAN.
1998 The same set of in-use VLANs applies to every interface on which VLAN
1999 splinters are enabled. That is, the set is not chosen separately for
2000 each interface but selected once as the union of all in-use VLANs based
2005 It does not make sense to enable VLAN splinters on an interface for an
2006 access port, or on an interface that is not a physical port.
2010 VLAN splinters are deprecated. When broken device drivers are no
2011 longer in widespread use, we will delete this feature.
2014 <column name="other_config" key="enable-vlan-splinters"
2015 type='{"type": "boolean"}'>
2017 Set to <code>true</code> to enable VLAN splinters on this interface.
2018 Defaults to <code>false</code>.
2022 VLAN splinters increase kernel and userspace memory overhead, so do
2023 not use them unless they are needed.
2027 VLAN splinters do not support 802.1p priority tags. Received
2028 priorities will appear to be 0, regardless of their actual values,
2029 and priorities on transmitted packets will also be cleared to 0.
2034 <group title="Common Columns">
2035 The overall purpose of these columns is described under <code>Common
2036 Columns</code> at the beginning of this document.
2038 <column name="other_config"/>
2039 <column name="external_ids"/>
2043 <table name="Flow_Table" title="OpenFlow table configuration">
2044 <p>Configuration for a particular OpenFlow table.</p>
2046 <column name="name">
2047 The table's name. Set this column to change the name that controllers
2048 will receive when they request table statistics, e.g. <code>ovs-ofctl
2049 dump-tables</code>. The name does not affect switch behavior.
2052 <column name="flow_limit">
2053 If set, limits the number of flows that may be added to the table. Open
2054 vSwitch may limit the number of flows in a table for other reasons,
2055 e.g. due to hardware limitations or for resource availability or
2056 performance reasons.
2059 <column name="overflow_policy">
2061 Controls the switch's behavior when an OpenFlow flow table modification
2062 request would add flows in excess of <ref column="flow_limit"/>. The
2063 supported values are:
2067 <dt><code>refuse</code></dt>
2069 Refuse to add the flow or flows. This is also the default policy
2070 when <ref column="overflow_policy"/> is unset.
2073 <dt><code>evict</code></dt>
2075 Delete the flow that will expire soonest. See <ref column="groups"/>
2081 <column name="groups">
2083 When <ref column="overflow_policy"/> is <code>evict</code>, this
2084 controls how flows are chosen for eviction when the flow table would
2085 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2086 of NXM fields or sub-fields, each of which takes one of the forms
2087 <code><var>field</var>[]</code> or
2088 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2089 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2090 <code>nicira-ext.h</code> for a complete list of NXM field names.
2094 When a flow must be evicted due to overflow, the flow to evict is
2095 chosen through an approximation of the following algorithm:
2100 Divide the flows in the table into groups based on the values of the
2101 specified fields or subfields, so that all of the flows in a given
2102 group have the same values for those fields. If a flow does not
2103 specify a given field, that field's value is treated as 0.
2107 Consider the flows in the largest group, that is, the group that
2108 contains the greatest number of flows. If two or more groups all
2109 have the same largest number of flows, consider the flows in all of
2114 Among the flows under consideration, choose the flow that expires
2115 soonest for eviction.
2120 The eviction process only considers flows that have an idle timeout or
2121 a hard timeout. That is, eviction never deletes permanent flows.
2122 (Permanent flows do count against <ref column="flow_limit"/>.)
2126 Open vSwitch ignores any invalid or unknown field specifications.
2130 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2131 column has no effect.
2136 <table name="QoS" title="Quality of Service configuration">
2137 <p>Quality of Service (QoS) configuration for each Port that
2140 <column name="type">
2141 <p>The type of QoS to implement. The currently defined types are
2144 <dt><code>linux-htb</code></dt>
2146 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2147 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2148 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2149 for information on how this classifier works and how to configure it.
2153 <dt><code>linux-hfsc</code></dt>
2155 Linux "Hierarchical Fair Service Curve" classifier.
2156 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2157 information on how this classifier works.
2162 <column name="queues">
2163 <p>A map from queue numbers to <ref table="Queue"/> records. The
2164 supported range of queue numbers depend on <ref column="type"/>. The
2165 queue numbers are the same as the <code>queue_id</code> used in
2166 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2170 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2171 actions when no specific queue has been set. When no configuration for
2172 queue 0 is present, it is automatically configured as if a <ref
2173 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2174 and <ref table="Queue" column="other_config"/> columns had been
2176 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2177 this case. With some queuing disciplines, this dropped all packets
2178 destined for the default queue.)
2182 <group title="Configuration for linux-htb and linux-hfsc">
2184 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2185 the following key-value pair:
2188 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2189 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2190 specified, for physical interfaces, the default is the link rate. For
2191 other interfaces or if the link rate cannot be determined, the default
2192 is currently 100 Mbps.
2196 <group title="Common Columns">
2197 The overall purpose of these columns is described under <code>Common
2198 Columns</code> at the beginning of this document.
2200 <column name="other_config"/>
2201 <column name="external_ids"/>
2205 <table name="Queue" title="QoS output queue.">
2206 <p>A configuration for a port output queue, used in configuring Quality of
2207 Service (QoS) features. May be referenced by <ref column="queues"
2208 table="QoS"/> column in <ref table="QoS"/> table.</p>
2210 <column name="dscp">
2211 If set, Open vSwitch will mark all traffic egressing this
2212 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2213 default <ref table="Queue"/> is only marked if it was explicitly selected
2214 as the <ref table="Queue"/> at the time the packet was output. If unset,
2215 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2219 <group title="Configuration for linux-htb QoS">
2221 <ref table="QoS"/> <ref table="QoS" column="type"/>
2222 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2223 It has the following key-value pairs defined.
2226 <column name="other_config" key="min-rate"
2227 type='{"type": "integer", "minInteger": 1}'>
2228 Minimum guaranteed bandwidth, in bit/s.
2231 <column name="other_config" key="max-rate"
2232 type='{"type": "integer", "minInteger": 1}'>
2233 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2234 queue's rate will not be allowed to exceed the specified value, even
2235 if excess bandwidth is available. If unspecified, defaults to no
2239 <column name="other_config" key="burst"
2240 type='{"type": "integer", "minInteger": 1}'>
2241 Burst size, in bits. This is the maximum amount of ``credits'' that a
2242 queue can accumulate while it is idle. Optional. Details of the
2243 <code>linux-htb</code> implementation require a minimum burst size, so
2244 a too-small <code>burst</code> will be silently ignored.
2247 <column name="other_config" key="priority"
2248 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2249 A queue with a smaller <code>priority</code> will receive all the
2250 excess bandwidth that it can use before a queue with a larger value
2251 receives any. Specific priority values are unimportant; only relative
2252 ordering matters. Defaults to 0 if unspecified.
2256 <group title="Configuration for linux-hfsc QoS">
2258 <ref table="QoS"/> <ref table="QoS" column="type"/>
2259 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2260 It has the following key-value pairs defined.
2263 <column name="other_config" key="min-rate"
2264 type='{"type": "integer", "minInteger": 1}'>
2265 Minimum guaranteed bandwidth, in bit/s.
2268 <column name="other_config" key="max-rate"
2269 type='{"type": "integer", "minInteger": 1}'>
2270 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2271 queue's rate will not be allowed to exceed the specified value, even if
2272 excess bandwidth is available. If unspecified, defaults to no
2277 <group title="Common Columns">
2278 The overall purpose of these columns is described under <code>Common
2279 Columns</code> at the beginning of this document.
2281 <column name="other_config"/>
2282 <column name="external_ids"/>
2286 <table name="Mirror" title="Port mirroring.">
2287 <p>A port mirror within a <ref table="Bridge"/>.</p>
2288 <p>A port mirror configures a bridge to send selected frames to special
2289 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2290 traffic may also be referred to as SPAN or RSPAN, depending on how
2291 the mirrored traffic is sent.</p>
2293 <column name="name">
2294 Arbitrary identifier for the <ref table="Mirror"/>.
2297 <group title="Selecting Packets for Mirroring">
2299 To be selected for mirroring, a given packet must enter or leave the
2300 bridge through a selected port and it must also be in one of the
2304 <column name="select_all">
2305 If true, every packet arriving or departing on any port is
2306 selected for mirroring.
2309 <column name="select_dst_port">
2310 Ports on which departing packets are selected for mirroring.
2313 <column name="select_src_port">
2314 Ports on which arriving packets are selected for mirroring.
2317 <column name="select_vlan">
2318 VLANs on which packets are selected for mirroring. An empty set
2319 selects packets on all VLANs.
2323 <group title="Mirroring Destination Configuration">
2325 These columns are mutually exclusive. Exactly one of them must be
2329 <column name="output_port">
2330 <p>Output port for selected packets, if nonempty.</p>
2331 <p>Specifying a port for mirror output reserves that port exclusively
2332 for mirroring. No frames other than those selected for mirroring
2334 will be forwarded to the port, and any frames received on the port
2335 will be discarded.</p>
2337 The output port may be any kind of port supported by Open vSwitch.
2338 It may be, for example, a physical port (sometimes called SPAN) or a
2343 <column name="output_vlan">
2344 <p>Output VLAN for selected packets, if nonempty.</p>
2345 <p>The frames will be sent out all ports that trunk
2346 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2347 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2348 trunk port, the frame's VLAN tag will be set to
2349 <ref column="output_vlan"/>, replacing any existing tag; when it is
2350 sent out an implicit VLAN port, the frame will not be tagged. This
2351 type of mirroring is sometimes called RSPAN.</p>
2353 See the documentation for
2354 <ref column="other_config" key="forward-bpdu"/> in the
2355 <ref table="Interface"/> table for a list of destination MAC
2356 addresses which will not be mirrored to a VLAN to avoid confusing
2357 switches that interpret the protocols that they represent.
2359 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2360 contains unmanaged switches. Consider an unmanaged physical switch
2361 with two ports: port 1, connected to an end host, and port 2,
2362 connected to an Open vSwitch configured to mirror received packets
2363 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2364 port 1 that the physical switch forwards to port 2. The Open vSwitch
2365 forwards this packet to its destination and then reflects it back on
2366 port 2 in VLAN 123. This reflected packet causes the unmanaged
2367 physical switch to replace the MAC learning table entry, which
2368 correctly pointed to port 1, with one that incorrectly points to port
2369 2. Afterward, the physical switch will direct packets destined for
2370 the end host to the Open vSwitch on port 2, instead of to the end
2371 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2372 desired in this scenario, then the physical switch must be replaced
2373 by one that learns Ethernet addresses on a per-VLAN basis. In
2374 addition, learning should be disabled on the VLAN containing mirrored
2375 traffic. If this is not done then intermediate switches will learn
2376 the MAC address of each end host from the mirrored traffic. If
2377 packets being sent to that end host are also mirrored, then they will
2378 be dropped since the switch will attempt to send them out the input
2379 port. Disabling learning for the VLAN will cause the switch to
2380 correctly send the packet out all ports configured for that VLAN. If
2381 Open vSwitch is being used as an intermediate switch, learning can be
2382 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2383 in the appropriate <ref table="Bridge"/> table or tables.</p>
2385 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2386 VLAN and should generally be preferred.
2391 <group title="Statistics: Mirror counters">
2393 Key-value pairs that report mirror statistics.
2395 <column name="statistics" key="tx_packets">
2396 Number of packets transmitted through this mirror.
2398 <column name="statistics" key="tx_bytes">
2399 Number of bytes transmitted through this mirror.
2403 <group title="Common Columns">
2404 The overall purpose of these columns is described under <code>Common
2405 Columns</code> at the beginning of this document.
2407 <column name="external_ids"/>
2411 <table name="Controller" title="OpenFlow controller configuration.">
2412 <p>An OpenFlow controller.</p>
2415 Open vSwitch supports two kinds of OpenFlow controllers:
2419 <dt>Primary controllers</dt>
2422 This is the kind of controller envisioned by the OpenFlow 1.0
2423 specification. Usually, a primary controller implements a network
2424 policy by taking charge of the switch's flow table.
2428 Open vSwitch initiates and maintains persistent connections to
2429 primary controllers, retrying the connection each time it fails or
2430 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2431 <ref table="Bridge"/> table applies to primary controllers.
2435 Open vSwitch permits a bridge to have any number of primary
2436 controllers. When multiple controllers are configured, Open
2437 vSwitch connects to all of them simultaneously. Because
2438 OpenFlow 1.0 does not specify how multiple controllers
2439 coordinate in interacting with a single switch, more than
2440 one primary controller should be specified only if the
2441 controllers are themselves designed to coordinate with each
2442 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2443 vendor extension may be useful for this.)
2446 <dt>Service controllers</dt>
2449 These kinds of OpenFlow controller connections are intended for
2450 occasional support and maintenance use, e.g. with
2451 <code>ovs-ofctl</code>. Usually a service controller connects only
2452 briefly to inspect or modify some of a switch's state.
2456 Open vSwitch listens for incoming connections from service
2457 controllers. The service controllers initiate and, if necessary,
2458 maintain the connections from their end. The <ref table="Bridge"
2459 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2460 not apply to service controllers.
2464 Open vSwitch supports configuring any number of service controllers.
2470 The <ref column="target"/> determines the type of controller.
2473 <group title="Core Features">
2474 <column name="target">
2475 <p>Connection method for controller.</p>
2477 The following connection methods are currently supported for primary
2481 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2483 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2484 the given <var>ip</var>, which must be expressed as an IP address
2485 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2486 column in the <ref table="Open_vSwitch"/> table must point to a
2487 valid SSL configuration when this form is used.</p>
2488 <p>SSL support is an optional feature that is not always built as
2489 part of Open vSwitch.</p>
2491 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2492 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2493 the given <var>ip</var>, which must be expressed as an IP address
2494 (not a DNS name).</dd>
2497 The following connection methods are currently supported for service
2501 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2504 Listens for SSL connections on the specified TCP <var>port</var>
2505 (default: 6633). If <var>ip</var>, which must be expressed as an
2506 IP address (not a DNS name), is specified, then connections are
2507 restricted to the specified local IP address.
2510 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2511 table="Open_vSwitch"/> table must point to a valid SSL
2512 configuration when this form is used.
2514 <p>SSL support is an optional feature that is not always built as
2515 part of Open vSwitch.</p>
2517 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2519 Listens for connections on the specified TCP <var>port</var>
2520 (default: 6633). If <var>ip</var>, which must be expressed as an
2521 IP address (not a DNS name), is specified, then connections are
2522 restricted to the specified local IP address.
2525 <p>When multiple controllers are configured for a single bridge, the
2526 <ref column="target"/> values must be unique. Duplicate
2527 <ref column="target"/> values yield unspecified results.</p>
2530 <column name="connection_mode">
2531 <p>If it is specified, this setting must be one of the following
2532 strings that describes how Open vSwitch contacts this OpenFlow
2533 controller over the network:</p>
2536 <dt><code>in-band</code></dt>
2537 <dd>In this mode, this controller's OpenFlow traffic travels over the
2538 bridge associated with the controller. With this setting, Open
2539 vSwitch allows traffic to and from the controller regardless of the
2540 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2541 would never be able to connect to the controller, because it did
2542 not have a flow to enable it.) This is the most common connection
2543 mode because it is not necessary to maintain two independent
2545 <dt><code>out-of-band</code></dt>
2546 <dd>In this mode, OpenFlow traffic uses a control network separate
2547 from the bridge associated with this controller, that is, the
2548 bridge does not use any of its own network devices to communicate
2549 with the controller. The control network must be configured
2550 separately, before or after <code>ovs-vswitchd</code> is started.
2554 <p>If not specified, the default is implementation-specific.</p>
2558 <group title="Controller Failure Detection and Handling">
2559 <column name="max_backoff">
2560 Maximum number of milliseconds to wait between connection attempts.
2561 Default is implementation-specific.
2564 <column name="inactivity_probe">
2565 Maximum number of milliseconds of idle time on connection to
2566 controller before sending an inactivity probe message. If Open
2567 vSwitch does not communicate with the controller for the specified
2568 number of seconds, it will send a probe. If a response is not
2569 received for the same additional amount of time, Open vSwitch
2570 assumes the connection has been broken and attempts to reconnect.
2571 Default is implementation-specific. A value of 0 disables
2576 <group title="Asynchronous Message Configuration">
2578 OpenFlow switches send certain messages to controllers spontanenously,
2579 that is, not in response to any request from the controller. These
2580 messages are called ``asynchronous messages.'' These columns allow
2581 asynchronous messages to be limited or disabled to ensure the best use
2582 of network resources.
2585 <column name="enable_async_messages">
2586 The OpenFlow protocol enables asynchronous messages at time of
2587 connection establishment, which means that a controller can receive
2588 asynchronous messages, potentially many of them, even if it turns them
2589 off immediately after connecting. Set this column to
2590 <code>false</code> to change Open vSwitch behavior to disable, by
2591 default, all asynchronous messages. The controller can use the
2592 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2593 on any messages that it does want to receive, if any.
2596 <column name="controller_rate_limit">
2598 The maximum rate at which the switch will forward packets to the
2599 OpenFlow controller, in packets per second. This feature prevents a
2600 single bridge from overwhelming the controller. If not specified,
2601 the default is implementation-specific.
2605 In addition, when a high rate triggers rate-limiting, Open vSwitch
2606 queues controller packets for each port and transmits them to the
2607 controller at the configured rate. The <ref
2608 column="controller_burst_limit"/> value limits the number of queued
2609 packets. Ports on a bridge share the packet queue fairly.
2613 Open vSwitch maintains two such packet rate-limiters per bridge: one
2614 for packets sent up to the controller because they do not correspond
2615 to any flow, and the other for packets sent up to the controller by
2616 request through flow actions. When both rate-limiters are filled with
2617 packets, the actual rate that packets are sent to the controller is
2618 up to twice the specified rate.
2622 <column name="controller_burst_limit">
2623 In conjunction with <ref column="controller_rate_limit"/>,
2624 the maximum number of unused packet credits that the bridge will
2625 allow to accumulate, in packets. If not specified, the default
2626 is implementation-specific.
2630 <group title="Additional In-Band Configuration">
2631 <p>These values are considered only in in-band control mode (see
2632 <ref column="connection_mode"/>).</p>
2634 <p>When multiple controllers are configured on a single bridge, there
2635 should be only one set of unique values in these columns. If different
2636 values are set for these columns in different controllers, the effect
2639 <column name="local_ip">
2640 The IP address to configure on the local port,
2641 e.g. <code>192.168.0.123</code>. If this value is unset, then
2642 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2646 <column name="local_netmask">
2647 The IP netmask to configure on the local port,
2648 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2649 but this value is unset, then the default is chosen based on whether
2650 the IP address is class A, B, or C.
2653 <column name="local_gateway">
2654 The IP address of the gateway to configure on the local port, as a
2655 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2656 this network has no gateway.
2660 <group title="Controller Status">
2661 <column name="is_connected">
2662 <code>true</code> if currently connected to this controller,
2663 <code>false</code> otherwise.
2667 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2668 <p>The level of authority this controller has on the associated
2669 bridge. Possible values are:</p>
2671 <dt><code>other</code></dt>
2672 <dd>Allows the controller access to all OpenFlow features.</dd>
2673 <dt><code>master</code></dt>
2674 <dd>Equivalent to <code>other</code>, except that there may be at
2675 most one master controller at a time. When a controller configures
2676 itself as <code>master</code>, any existing master is demoted to
2677 the <code>slave</code>role.</dd>
2678 <dt><code>slave</code></dt>
2679 <dd>Allows the controller read-only access to OpenFlow features.
2680 Attempts to modify the flow table will be rejected with an
2681 error. Slave controllers do not receive OFPT_PACKET_IN or
2682 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2687 <column name="status" key="last_error">
2688 A human-readable description of the last error on the connection
2689 to the controller; i.e. <code>strerror(errno)</code>. This key
2690 will exist only if an error has occurred.
2693 <column name="status" key="state"
2694 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2696 The state of the connection to the controller:
2699 <dt><code>VOID</code></dt>
2700 <dd>Connection is disabled.</dd>
2702 <dt><code>BACKOFF</code></dt>
2703 <dd>Attempting to reconnect at an increasing period.</dd>
2705 <dt><code>CONNECTING</code></dt>
2706 <dd>Attempting to connect.</dd>
2708 <dt><code>ACTIVE</code></dt>
2709 <dd>Connected, remote host responsive.</dd>
2711 <dt><code>IDLE</code></dt>
2712 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2715 These values may change in the future. They are provided only for
2720 <column name="status" key="sec_since_connect"
2721 type='{"type": "integer", "minInteger": 0}'>
2722 The amount of time since this controller last successfully connected to
2723 the switch (in seconds). Value is empty if controller has never
2724 successfully connected.
2727 <column name="status" key="sec_since_disconnect"
2728 type='{"type": "integer", "minInteger": 1}'>
2729 The amount of time since this controller last disconnected from
2730 the switch (in seconds). Value is empty if controller has never
2735 <group title="Connection Parameters">
2737 Additional configuration for a connection between the controller
2738 and the Open vSwitch.
2741 <column name="other_config" key="dscp"
2742 type='{"type": "integer"}'>
2743 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2744 in the Type of Service (TOS) field in the IP header. DSCP provides a
2745 mechanism to classify the network traffic and provide Quality of
2746 Service (QoS) on IP networks.
2748 The DSCP value specified here is used when establishing the connection
2749 between the controller and the Open vSwitch. If no value is specified,
2750 a default value of 48 is chosen. Valid DSCP values must be in the
2756 <group title="Common Columns">
2757 The overall purpose of these columns is described under <code>Common
2758 Columns</code> at the beginning of this document.
2760 <column name="external_ids"/>
2761 <column name="other_config"/>
2765 <table name="Manager" title="OVSDB management connection.">
2767 Configuration for a database connection to an Open vSwitch database
2772 This table primarily configures the Open vSwitch database
2773 (<code>ovsdb-server</code>), not the Open vSwitch switch
2774 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2775 what connections should be treated as in-band.
2779 The Open vSwitch database server can initiate and maintain active
2780 connections to remote clients. It can also listen for database
2784 <group title="Core Features">
2785 <column name="target">
2786 <p>Connection method for managers.</p>
2788 The following connection methods are currently supported:
2791 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2794 The specified SSL <var>port</var> (default: 6632) on the host at
2795 the given <var>ip</var>, which must be expressed as an IP address
2796 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2797 column in the <ref table="Open_vSwitch"/> table must point to a
2798 valid SSL configuration when this form is used.
2801 SSL support is an optional feature that is not always built as
2802 part of Open vSwitch.
2806 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2808 The specified TCP <var>port</var> (default: 6632) on the host at
2809 the given <var>ip</var>, which must be expressed as an IP address
2812 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2815 Listens for SSL connections on the specified TCP <var>port</var>
2816 (default: 6632). If <var>ip</var>, which must be expressed as an
2817 IP address (not a DNS name), is specified, then connections are
2818 restricted to the specified local IP address.
2821 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2822 table="Open_vSwitch"/> table must point to a valid SSL
2823 configuration when this form is used.
2826 SSL support is an optional feature that is not always built as
2827 part of Open vSwitch.
2830 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2832 Listens for connections on the specified TCP <var>port</var>
2833 (default: 6632). If <var>ip</var>, which must be expressed as an
2834 IP address (not a DNS name), is specified, then connections are
2835 restricted to the specified local IP address.
2838 <p>When multiple managers are configured, the <ref column="target"/>
2839 values must be unique. Duplicate <ref column="target"/> values yield
2840 unspecified results.</p>
2843 <column name="connection_mode">
2845 If it is specified, this setting must be one of the following strings
2846 that describes how Open vSwitch contacts this OVSDB client over the
2851 <dt><code>in-band</code></dt>
2853 In this mode, this connection's traffic travels over a bridge
2854 managed by Open vSwitch. With this setting, Open vSwitch allows
2855 traffic to and from the client regardless of the contents of the
2856 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2857 to connect to the client, because it did not have a flow to enable
2858 it.) This is the most common connection mode because it is not
2859 necessary to maintain two independent networks.
2861 <dt><code>out-of-band</code></dt>
2863 In this mode, the client's traffic uses a control network separate
2864 from that managed by Open vSwitch, that is, Open vSwitch does not
2865 use any of its own network devices to communicate with the client.
2866 The control network must be configured separately, before or after
2867 <code>ovs-vswitchd</code> is started.
2872 If not specified, the default is implementation-specific.
2877 <group title="Client Failure Detection and Handling">
2878 <column name="max_backoff">
2879 Maximum number of milliseconds to wait between connection attempts.
2880 Default is implementation-specific.
2883 <column name="inactivity_probe">
2884 Maximum number of milliseconds of idle time on connection to the client
2885 before sending an inactivity probe message. If Open vSwitch does not
2886 communicate with the client for the specified number of seconds, it
2887 will send a probe. If a response is not received for the same
2888 additional amount of time, Open vSwitch assumes the connection has been
2889 broken and attempts to reconnect. Default is implementation-specific.
2890 A value of 0 disables inactivity probes.
2894 <group title="Status">
2895 <column name="is_connected">
2896 <code>true</code> if currently connected to this manager,
2897 <code>false</code> otherwise.
2900 <column name="status" key="last_error">
2901 A human-readable description of the last error on the connection
2902 to the manager; i.e. <code>strerror(errno)</code>. This key
2903 will exist only if an error has occurred.
2906 <column name="status" key="state"
2907 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2909 The state of the connection to the manager:
2912 <dt><code>VOID</code></dt>
2913 <dd>Connection is disabled.</dd>
2915 <dt><code>BACKOFF</code></dt>
2916 <dd>Attempting to reconnect at an increasing period.</dd>
2918 <dt><code>CONNECTING</code></dt>
2919 <dd>Attempting to connect.</dd>
2921 <dt><code>ACTIVE</code></dt>
2922 <dd>Connected, remote host responsive.</dd>
2924 <dt><code>IDLE</code></dt>
2925 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2928 These values may change in the future. They are provided only for
2933 <column name="status" key="sec_since_connect"
2934 type='{"type": "integer", "minInteger": 0}'>
2935 The amount of time since this manager last successfully connected
2936 to the database (in seconds). Value is empty if manager has never
2937 successfully connected.
2940 <column name="status" key="sec_since_disconnect"
2941 type='{"type": "integer", "minInteger": 0}'>
2942 The amount of time since this manager last disconnected from the
2943 database (in seconds). Value is empty if manager has never
2947 <column name="status" key="locks_held">
2948 Space-separated list of the names of OVSDB locks that the connection
2949 holds. Omitted if the connection does not hold any locks.
2952 <column name="status" key="locks_waiting">
2953 Space-separated list of the names of OVSDB locks that the connection is
2954 currently waiting to acquire. Omitted if the connection is not waiting
2958 <column name="status" key="locks_lost">
2959 Space-separated list of the names of OVSDB locks that the connection
2960 has had stolen by another OVSDB client. Omitted if no locks have been
2961 stolen from this connection.
2964 <column name="status" key="n_connections"
2965 type='{"type": "integer", "minInteger": 2}'>
2967 When <ref column="target"/> specifies a connection method that
2968 listens for inbound connections (e.g. <code>ptcp:</code> or
2969 <code>pssl:</code>) and more than one connection is actually active,
2970 the value is the number of active connections. Otherwise, this
2971 key-value pair is omitted.
2974 When multiple connections are active, status columns and key-value
2975 pairs (other than this one) report the status of one arbitrarily
2981 <group title="Connection Parameters">
2983 Additional configuration for a connection between the manager
2984 and the Open vSwitch Database.
2987 <column name="other_config" key="dscp"
2988 type='{"type": "integer"}'>
2989 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2990 in the Type of Service (TOS) field in the IP header. DSCP provides a
2991 mechanism to classify the network traffic and provide Quality of
2992 Service (QoS) on IP networks.
2994 The DSCP value specified here is used when establishing the connection
2995 between the manager and the Open vSwitch. If no value is specified, a
2996 default value of 48 is chosen. Valid DSCP values must be in the range
3001 <group title="Common Columns">
3002 The overall purpose of these columns is described under <code>Common
3003 Columns</code> at the beginning of this document.
3005 <column name="external_ids"/>
3006 <column name="other_config"/>
3010 <table name="NetFlow">
3011 A NetFlow target. NetFlow is a protocol that exports a number of
3012 details about terminating IP flows, such as the principals involved
3015 <column name="targets">
3016 NetFlow targets in the form
3017 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3018 must be specified numerically, not as a DNS name.
3021 <column name="engine_id">
3022 Engine ID to use in NetFlow messages. Defaults to datapath index
3026 <column name="engine_type">
3027 Engine type to use in NetFlow messages. Defaults to datapath
3028 index if not specified.
3031 <column name="active_timeout">
3032 The interval at which NetFlow records are sent for flows that are
3033 still active, in seconds. A value of <code>0</code> requests the
3034 default timeout (currently 600 seconds); a value of <code>-1</code>
3035 disables active timeouts.
3038 <column name="add_id_to_interface">
3039 <p>If this column's value is <code>false</code>, the ingress and egress
3040 interface fields of NetFlow flow records are derived from OpenFlow port
3041 numbers. When it is <code>true</code>, the 7 most significant bits of
3042 these fields will be replaced by the least significant 7 bits of the
3043 engine id. This is useful because many NetFlow collectors do not
3044 expect multiple switches to be sending messages from the same host, so
3045 they do not store the engine information which could be used to
3046 disambiguate the traffic.</p>
3047 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3050 <group title="Common Columns">
3051 The overall purpose of these columns is described under <code>Common
3052 Columns</code> at the beginning of this document.
3054 <column name="external_ids"/>
3059 SSL configuration for an Open_vSwitch.
3061 <column name="private_key">
3062 Name of a PEM file containing the private key used as the switch's
3063 identity for SSL connections to the controller.
3066 <column name="certificate">
3067 Name of a PEM file containing a certificate, signed by the
3068 certificate authority (CA) used by the controller and manager,
3069 that certifies the switch's private key, identifying a trustworthy
3073 <column name="ca_cert">
3074 Name of a PEM file containing the CA certificate used to verify
3075 that the switch is connected to a trustworthy controller.
3078 <column name="bootstrap_ca_cert">
3079 If set to <code>true</code>, then Open vSwitch will attempt to
3080 obtain the CA certificate from the controller on its first SSL
3081 connection and save it to the named PEM file. If it is successful,
3082 it will immediately drop the connection and reconnect, and from then
3083 on all SSL connections must be authenticated by a certificate signed
3084 by the CA certificate thus obtained. <em>This option exposes the
3085 SSL connection to a man-in-the-middle attack obtaining the initial
3086 CA certificate.</em> It may still be useful for bootstrapping.
3089 <group title="Common Columns">
3090 The overall purpose of these columns is described under <code>Common
3091 Columns</code> at the beginning of this document.
3093 <column name="external_ids"/>
3097 <table name="sFlow">
3098 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3101 <column name="agent">
3102 Name of the network device whose IP address should be reported as the
3103 ``agent address'' to collectors. If not specified, the agent device is
3104 figured from the first target address and the routing table. If the
3105 routing table does not contain a route to the target, the IP address
3106 defaults to the <ref table="Controller" column="local_ip"/> in the
3107 collector's <ref table="Controller"/>. If an agent IP address cannot be
3108 determined any of these ways, sFlow is disabled.
3111 <column name="header">
3112 Number of bytes of a sampled packet to send to the collector.
3113 If not specified, the default is 128 bytes.
3116 <column name="polling">
3117 Polling rate in seconds to send port statistics to the collector.
3118 If not specified, defaults to 30 seconds.
3121 <column name="sampling">
3122 Rate at which packets should be sampled and sent to the collector.
3123 If not specified, defaults to 400, which means one out of 400
3124 packets, on average, will be sent to the collector.
3127 <column name="targets">
3128 sFlow targets in the form
3129 <code><var>ip</var>:<var>port</var></code>.
3132 <group title="Common Columns">
3133 The overall purpose of these columns is described under <code>Common
3134 Columns</code> at the beginning of this document.
3136 <column name="external_ids"/>