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="dp-desc">
443 Human readable description of datapath. It it a maximum 256
444 byte-long free-form string to describe the datapath for
445 debugging purposes, e.g. <code>switch3 in room 3120</code>.
448 <column name="other_config" key="disable-in-band"
449 type='{"type": "boolean"}'>
450 If set to <code>true</code>, disable in-band control on the bridge
451 regardless of controller and manager settings.
454 <column name="other_config" key="in-band-queue"
455 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
456 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
457 that will be used by flows set up by in-band control on this bridge.
458 If unset, or if the port used by an in-band control flow does not have
459 QoS configured, or if the port does not have a queue with the specified
460 ID, the default queue is used instead.
463 <column name="protocols">
464 List of OpenFlow protocols that may be used when negotiating a
465 connection with a controller. A default value of
466 <code>OpenFlow10</code> will be used if this column is empty.
470 <group title="Spanning Tree Configuration">
471 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
472 that ensures loop-free topologies. It allows redundant links to
473 be included in the network to provide automatic backup paths if
474 the active links fails.
476 <column name="stp_enable">
477 Enable spanning tree on the bridge. By default, STP is disabled
478 on bridges. Bond, internal, and mirror ports are not supported
479 and will not participate in the spanning tree.
482 <column name="other_config" key="stp-system-id">
483 The bridge's STP identifier (the lower 48 bits of the bridge-id)
485 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
486 By default, the identifier is the MAC address of the bridge.
489 <column name="other_config" key="stp-priority"
490 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
491 The bridge's relative priority value for determining the root
492 bridge (the upper 16 bits of the bridge-id). A bridge with the
493 lowest bridge-id is elected the root. By default, the priority
497 <column name="other_config" key="stp-hello-time"
498 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
499 The interval between transmissions of hello messages by
500 designated ports, in seconds. By default the hello interval is
504 <column name="other_config" key="stp-max-age"
505 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
506 The maximum age of the information transmitted by the bridge
507 when it is the root bridge, in seconds. By default, the maximum
511 <column name="other_config" key="stp-forward-delay"
512 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
513 The delay to wait between transitioning root and designated
514 ports to <code>forwarding</code>, in seconds. By default, the
515 forwarding delay is 15 seconds.
519 <group title="Other Features">
520 <column name="datapath_type">
521 Name of datapath provider. The kernel datapath has
522 type <code>system</code>. The userspace datapath has
523 type <code>netdev</code>.
526 <column name="external_ids" key="bridge-id">
527 A unique identifier of the bridge. On Citrix XenServer this will
528 commonly be the same as
529 <ref column="external_ids" key="xs-network-uuids"/>.
532 <column name="external_ids" key="xs-network-uuids">
533 Semicolon-delimited set of universally unique identifier(s) for the
534 network with which this bridge is associated on a Citrix XenServer
535 host. The network identifiers are RFC 4122 UUIDs as displayed by,
536 e.g., <code>xe network-list</code>.
539 <column name="other_config" key="hwaddr">
540 An Ethernet address in the form
541 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
542 to set the hardware address of the local port and influence the
546 <column name="other_config" key="flow-eviction-threshold"
547 type='{"type": "integer", "minInteger": 0}'>
549 A number of flows as a nonnegative integer. This sets number of
550 flows at which eviction from the kernel flow table will be triggered.
551 If there are a large number of flows then increasing this value to
552 around the number of flows present can result in reduced CPU usage
556 The default is 1000. Values below 100 will be rounded up to 100.
560 <column name="other_config" key="forward-bpdu"
561 type='{"type": "boolean"}'>
562 Option to allow forwarding of BPDU frames when NORMAL action is
563 invoked. Frames with reserved Ethernet addresses (e.g. STP
564 BPDU) will be forwarded when this option is enabled and the
565 switch is not providing that functionality. If STP is enabled
566 on the port, STP BPDUs will never be forwarded. If the Open
567 vSwitch bridge is used to connect different Ethernet networks,
568 and if Open vSwitch node does not run STP, then this option
569 should be enabled. Default is disabled, set to
570 <code>true</code> to enable.
572 The following destination MAC addresss will not be forwarded when this
575 <dt><code>01:80:c2:00:00:00</code></dt>
576 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
578 <dt><code>01:80:c2:00:00:01</code></dt>
579 <dd>IEEE Pause frame.</dd>
581 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
582 <dd>Other reserved protocols.</dd>
584 <dt><code>00:e0:2b:00:00:00</code></dt>
585 <dd>Extreme Discovery Protocol (EDP).</dd>
588 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
590 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
592 <dt><code>01:00:0c:cc:cc:cc</code></dt>
594 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
595 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
599 <dt><code>01:00:0c:cc:cc:cd</code></dt>
600 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
602 <dt><code>01:00:0c:cd:cd:cd</code></dt>
603 <dd>Cisco STP Uplink Fast.</dd>
605 <dt><code>01:00:0c:00:00:00</code></dt>
606 <dd>Cisco Inter Switch Link.</dd>
608 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
613 <column name="other_config" key="mac-aging-time"
614 type='{"type": "integer", "minInteger": 1}'>
616 The maximum number of seconds to retain a MAC learning entry for
617 which no packets have been seen. The default is currently 300
618 seconds (5 minutes). The value, if specified, is forced into a
619 reasonable range, currently 15 to 3600 seconds.
623 A short MAC aging time allows a network to more quickly detect that a
624 host is no longer connected to a switch port. However, it also makes
625 it more likely that packets will be flooded unnecessarily, when they
626 are addressed to a connected host that rarely transmits packets. To
627 reduce the incidence of unnecessary flooding, use a MAC aging time
628 longer than the maximum interval at which a host will ordinarily
633 <column name="other_config" key="mac-table-size"
634 type='{"type": "integer", "minInteger": 1}'>
636 The maximum number of MAC addresses to learn. The default is
637 currently 2048. The value, if specified, is forced into a reasonable
638 range, currently 10 to 1,000,000.
643 <group title="Bridge Status">
645 Status information about bridges.
647 <column name="status">
648 Key-value pairs that report bridge status.
650 <column name="status" key="stp_bridge_id">
652 The bridge-id (in hex) used in spanning tree advertisements.
653 Configuring the bridge-id is described in the
654 <code>stp-system-id</code> and <code>stp-priority</code> keys
655 of the <code>other_config</code> section earlier.
658 <column name="status" key="stp_designated_root">
660 The designated root (in hex) for this spanning tree.
663 <column name="status" key="stp_root_path_cost">
665 The path cost of reaching the designated bridge. A lower
671 <group title="Common Columns">
672 The overall purpose of these columns is described under <code>Common
673 Columns</code> at the beginning of this document.
675 <column name="other_config"/>
676 <column name="external_ids"/>
680 <table name="Port" table="Port or bond configuration.">
681 <p>A port within a <ref table="Bridge"/>.</p>
682 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
683 <ref column="interfaces"/> column. Such a port logically
684 corresponds to a port on a physical Ethernet switch. A port
685 with more than one interface is a ``bonded port'' (see
686 <ref group="Bonding Configuration"/>).</p>
687 <p>Some properties that one might think as belonging to a port are actually
688 part of the port's <ref table="Interface"/> members.</p>
691 Port name. Should be alphanumeric and no more than about 8
692 bytes long. May be the same as the interface name, for
693 non-bonded ports. Must otherwise be unique among the names of
694 ports, interfaces, and bridges on a host.
697 <column name="interfaces">
698 The port's interfaces. If there is more than one, this is a
702 <group title="VLAN Configuration">
703 <p>Bridge ports support the following types of VLAN configuration:</p>
708 A trunk port carries packets on one or more specified VLANs
709 specified in the <ref column="trunks"/> column (often, on every
710 VLAN). A packet that ingresses on a trunk port is in the VLAN
711 specified in its 802.1Q header, or VLAN 0 if the packet has no
712 802.1Q header. A packet that egresses through a trunk port will
713 have an 802.1Q header if it has a nonzero VLAN ID.
717 Any packet that ingresses on a trunk port tagged with a VLAN that
718 the port does not trunk is dropped.
725 An access port carries packets on exactly one VLAN specified in the
726 <ref column="tag"/> column. Packets egressing on an access port
727 have no 802.1Q header.
731 Any packet with an 802.1Q header with a nonzero VLAN ID that
732 ingresses on an access port is dropped, regardless of whether the
733 VLAN ID in the header is the access port's VLAN ID.
737 <dt>native-tagged</dt>
739 A native-tagged port resembles a trunk port, with the exception that
740 a packet without an 802.1Q header that ingresses on a native-tagged
741 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
745 <dt>native-untagged</dt>
747 A native-untagged port resembles a native-tagged port, with the
748 exception that a packet that egresses on a native-untagged port in
749 the native VLAN will not have an 802.1Q header.
753 A packet will only egress through bridge ports that carry the VLAN of
754 the packet, as described by the rules above.
757 <column name="vlan_mode">
759 The VLAN mode of the port, as described above. When this column is
760 empty, a default mode is selected as follows:
764 If <ref column="tag"/> contains a value, the port is an access
765 port. The <ref column="trunks"/> column should be empty.
768 Otherwise, the port is a trunk port. The <ref column="trunks"/>
769 column value is honored if it is present.
776 For an access port, the port's implicitly tagged VLAN. For a
777 native-tagged or native-untagged port, the port's native VLAN. Must
778 be empty if this is a trunk port.
782 <column name="trunks">
784 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
785 or VLANs that this port trunks; if it is empty, then the port trunks
786 all VLANs. Must be empty if this is an access port.
789 A native-tagged or native-untagged port always trunks its native
790 VLAN, regardless of whether <ref column="trunks"/> includes that
795 <column name="other_config" key="priority-tags"
796 type='{"type": "boolean"}'>
798 An 802.1Q header contains two important pieces of information: a VLAN
799 ID and a priority. A frame with a zero VLAN ID, called a
800 ``priority-tagged'' frame, is supposed to be treated the same way as
801 a frame without an 802.1Q header at all (except for the priority).
805 However, some network elements ignore any frame that has 802.1Q
806 header at all, even when the VLAN ID is zero. Therefore, by default
807 Open vSwitch does not output priority-tagged frames, instead omitting
808 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
809 <code>true</code> to enable priority-tagged frames on a port.
813 Regardless of this setting, Open vSwitch omits the 802.1Q header on
814 output if both the VLAN ID and priority would be zero.
818 All frames output to native-tagged ports have a nonzero VLAN ID, so
819 this setting is not meaningful on native-tagged ports.
824 <group title="Bonding Configuration">
825 <p>A port that has more than one interface is a ``bonded port.'' Bonding
826 allows for load balancing and fail-over.</p>
829 The following types of bonding will work with any kind of upstream
830 switch. On the upstream switch, do not configure the interfaces as a
835 <dt><code>balance-slb</code></dt>
837 Balances flows among slaves based on source MAC address and output
838 VLAN, with periodic rebalancing as traffic patterns change.
841 <dt><code>active-backup</code></dt>
843 Assigns all flows to one slave, failing over to a backup slave when
844 the active slave is disabled. This is the only bonding mode in which
845 interfaces may be plugged into different upstream switches.
850 The following modes require the upstream switch to support 802.3ad with
851 successful LACP negotiation:
855 <dt><code>balance-tcp</code></dt>
857 Balances flows among slaves based on L2, L3, and L4 protocol
858 information such as destination MAC address, IP address, and TCP
863 <p>These columns apply only to bonded ports. Their values are
864 otherwise ignored.</p>
866 <column name="bond_mode">
867 <p>The type of bonding used for a bonded port. Defaults to
868 <code>active-backup</code> if unset.
872 <column name="other_config" key="bond-hash-basis"
873 type='{"type": "integer"}'>
874 An integer hashed along with flows when choosing output slaves in load
875 balanced bonds. When changed, all flows will be assigned different
876 hash values possibly causing slave selection decisions to change. Does
877 not affect bonding modes which do not employ load balancing such as
878 <code>active-backup</code>.
881 <group title="Link Failure Detection">
883 An important part of link bonding is detecting that links are down so
884 that they may be disabled. These settings determine how Open vSwitch
885 detects link failure.
888 <column name="other_config" key="bond-detect-mode"
889 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
890 The means used to detect link failures. Defaults to
891 <code>carrier</code> which uses each interface's carrier to detect
892 failures. When set to <code>miimon</code>, will check for failures
893 by polling each interface's MII.
896 <column name="other_config" key="bond-miimon-interval"
897 type='{"type": "integer"}'>
898 The interval, in milliseconds, between successive attempts to poll
899 each interface's MII. Relevant only when <ref column="other_config"
900 key="bond-detect-mode"/> is <code>miimon</code>.
903 <column name="bond_updelay">
905 The number of milliseconds for which the link must stay up on an
906 interface before the interface is considered to be up. Specify
907 <code>0</code> to enable the interface immediately.
911 This setting is honored only when at least one bonded interface is
912 already enabled. When no interfaces are enabled, then the first
913 bond interface to come up is enabled immediately.
917 <column name="bond_downdelay">
918 The number of milliseconds for which the link must stay down on an
919 interface before the interface is considered to be down. Specify
920 <code>0</code> to disable the interface immediately.
924 <group title="LACP Configuration">
926 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
927 allows switches to automatically detect that they are connected by
928 multiple links and aggregate across those links. These settings
929 control LACP behavior.
933 Configures LACP on this port. LACP allows directly connected
934 switches to negotiate which links may be bonded. LACP may be enabled
935 on non-bonded ports for the benefit of any switches they may be
936 connected to. <code>active</code> ports are allowed to initiate LACP
937 negotiations. <code>passive</code> ports are allowed to participate
938 in LACP negotiations initiated by a remote switch, but not allowed to
939 initiate such negotiations themselves. If LACP is enabled on a port
940 whose partner switch does not support LACP, the bond will be
941 disabled. Defaults to <code>off</code> if unset.
944 <column name="other_config" key="lacp-system-id">
945 The LACP system ID of this <ref table="Port"/>. The system ID of a
946 LACP bond is used to identify itself to its partners. Must be a
947 nonzero MAC address. Defaults to the bridge Ethernet address if
951 <column name="other_config" key="lacp-system-priority"
952 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
953 The LACP system priority of this <ref table="Port"/>. In LACP
954 negotiations, link status decisions are made by the system with the
955 numerically lower priority.
958 <column name="other_config" key="lacp-time"
959 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
961 The LACP timing which should be used on this <ref table="Port"/>.
962 By default <code>slow</code> is used. When configured to be
963 <code>fast</code> LACP heartbeats are requested at a rate of once
964 per second causing connectivity problems to be detected more
965 quickly. In <code>slow</code> mode, heartbeats are requested at a
966 rate of once every 30 seconds.
971 <group title="Rebalancing Configuration">
973 These settings control behavior when a bond is in
974 <code>balance-slb</code> or <code>balance-tcp</code> mode.
977 <column name="other_config" key="bond-rebalance-interval"
978 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
979 For a load balanced bonded port, the number of milliseconds between
980 successive attempts to rebalance the bond, that is, to move flows
981 from one interface on the bond to another in an attempt to keep usage
982 of each interface roughly equal. If zero, load balancing is disabled
983 on the bond (link failure still cause flows to move). If
984 less than 1000ms, the rebalance interval will be 1000ms.
988 <column name="bond_fake_iface">
989 For a bonded port, whether to create a fake internal interface with the
990 name of the port. Use only for compatibility with legacy software that
995 <group title="Spanning Tree Configuration">
996 <column name="other_config" key="stp-enable"
997 type='{"type": "boolean"}'>
998 If spanning tree is enabled on the bridge, member ports are
999 enabled by default (with the exception of bond, internal, and
1000 mirror ports which do not work with STP). If this column's
1001 value is <code>false</code> spanning tree is disabled on the
1005 <column name="other_config" key="stp-port-num"
1006 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1007 The port number used for the lower 8 bits of the port-id. By
1008 default, the numbers will be assigned automatically. If any
1009 port's number is manually configured on a bridge, then they
1013 <column name="other_config" key="stp-port-priority"
1014 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1015 The port's relative priority value for determining the root
1016 port (the upper 8 bits of the port-id). A port with a lower
1017 port-id will be chosen as the root port. By default, the
1021 <column name="other_config" key="stp-path-cost"
1022 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1023 Spanning tree path cost for the port. A lower number indicates
1024 a faster link. By default, the cost is based on the maximum
1029 <group title="Other Features">
1031 Quality of Service configuration for this port.
1035 The MAC address to use for this port for the purpose of choosing the
1036 bridge's MAC address. This column does not necessarily reflect the
1037 port's actual MAC address, nor will setting it change the port's actual
1041 <column name="fake_bridge">
1042 Does this port represent a sub-bridge for its tagged VLAN within the
1043 Bridge? See ovs-vsctl(8) for more information.
1046 <column name="external_ids" key="fake-bridge-id-*">
1047 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1048 column) are defined by prefixing a <ref table="Bridge"/> <ref
1049 table="Bridge" column="external_ids"/> key with
1050 <code>fake-bridge-</code>,
1051 e.g. <code>fake-bridge-xs-network-uuids</code>.
1055 <group title="Port Status">
1057 Status information about ports attached to bridges.
1059 <column name="status">
1060 Key-value pairs that report port status.
1062 <column name="status" key="stp_port_id">
1064 The port-id (in hex) used in spanning tree advertisements for
1065 this port. Configuring the port-id is described in the
1066 <code>stp-port-num</code> and <code>stp-port-priority</code>
1067 keys of the <code>other_config</code> section earlier.
1070 <column name="status" key="stp_state"
1071 type='{"type": "string", "enum": ["set",
1072 ["disabled", "listening", "learning",
1073 "forwarding", "blocking"]]}'>
1075 STP state of the port.
1078 <column name="status" key="stp_sec_in_state"
1079 type='{"type": "integer", "minInteger": 0}'>
1081 The amount of time (in seconds) port has been in the current
1085 <column name="status" key="stp_role"
1086 type='{"type": "string", "enum": ["set",
1087 ["root", "designated", "alternate"]]}'>
1089 STP role of the port.
1094 <group title="Port Statistics">
1096 Key-value pairs that report port statistics.
1098 <group title="Statistics: STP transmit and receive counters">
1099 <column name="statistics" key="stp_tx_count">
1100 Number of STP BPDUs sent on this port by the spanning
1103 <column name="statistics" key="stp_rx_count">
1104 Number of STP BPDUs received on this port and accepted by the
1105 spanning tree library.
1107 <column name="statistics" key="stp_error_count">
1108 Number of bad STP BPDUs received on this port. Bad BPDUs
1109 include runt packets and those with an unexpected protocol ID.
1114 <group title="Common Columns">
1115 The overall purpose of these columns is described under <code>Common
1116 Columns</code> at the beginning of this document.
1118 <column name="other_config"/>
1119 <column name="external_ids"/>
1123 <table name="Interface" title="One physical network device in a Port.">
1124 An interface within a <ref table="Port"/>.
1126 <group title="Core Features">
1127 <column name="name">
1128 Interface name. Should be alphanumeric and no more than about 8 bytes
1129 long. May be the same as the port name, for non-bonded ports. Must
1130 otherwise be unique among the names of ports, interfaces, and bridges
1135 <p>Ethernet address to set for this interface. If unset then the
1136 default MAC address is used:</p>
1138 <li>For the local interface, the default is the lowest-numbered MAC
1139 address among the other bridge ports, either the value of the
1140 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1141 if set, or its actual MAC (for bonded ports, the MAC of its slave
1142 whose name is first in alphabetical order). Internal ports and
1143 bridge ports that are used as port mirroring destinations (see the
1144 <ref table="Mirror"/> table) are ignored.</li>
1145 <li>For other internal interfaces, the default MAC is randomly
1147 <li>External interfaces typically have a MAC address associated with
1148 their hardware.</li>
1150 <p>Some interfaces may not have a software-controllable MAC
1154 <column name="ofport">
1155 <p>OpenFlow port number for this interface. Unlike most columns, this
1156 column's value should be set only by Open vSwitch itself. Other
1157 clients should set this column to an empty set (the default) when
1158 creating an <ref table="Interface"/>.</p>
1159 <p>Open vSwitch populates this column when the port number becomes
1160 known. If the interface is successfully added,
1161 <ref column="ofport"/> will be set to a number between 1 and 65535
1162 (generally either in the range 1 to 65279, inclusive, or 65534, the
1163 port number for the OpenFlow ``local port''). If the interface
1164 cannot be added then Open vSwitch sets this column
1166 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1167 an appropriate value for this column and then tries to keep the value
1168 constant across restarts.</p>
1171 <column name="ofport_request">
1172 <p>Requested OpenFlow port number for this interface. The port
1173 number must be between 1 and 65279, inclusive. Some datapaths
1174 cannot satisfy all requests for particular port numbers. When
1175 this column is empty or the request cannot be fulfilled, the
1176 system will choose a free port. The <ref column="ofport"/>
1177 column reports the assigned OpenFlow port number.</p>
1178 <p>The port number must be requested in the same transaction
1179 that creates the port.</p>
1183 <group title="System-Specific Details">
1184 <column name="type">
1186 The interface type, one of:
1190 <dt><code>system</code></dt>
1191 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1192 Sometimes referred to as ``external interfaces'' since they are
1193 generally connected to hardware external to that on which the Open
1194 vSwitch is running. The empty string is a synonym for
1195 <code>system</code>.</dd>
1197 <dt><code>internal</code></dt>
1198 <dd>A simulated network device that sends and receives traffic. An
1199 internal interface whose <ref column="name"/> is the same as its
1200 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1201 ``local interface.'' It does not make sense to bond an internal
1202 interface, so the terms ``port'' and ``interface'' are often used
1203 imprecisely for internal interfaces.</dd>
1205 <dt><code>tap</code></dt>
1206 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1208 <dt><code>gre</code></dt>
1210 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1214 <dt><code>ipsec_gre</code></dt>
1216 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1220 <dt><code>gre64</code></dt>
1222 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1223 of key, it uses GRE protocol sequence number field. This is non
1224 standard use of GRE protocol since OVS does not increment
1225 sequence number for every packet at time of encap as expected by
1226 standard GRE implementation. See <ref group="Tunnel Options"/>
1227 for information on configuring GRE tunnels.
1230 <dt><code>ipsec_gre64</code></dt>
1232 Same as IPSEC_GRE except 64 bit key.
1235 <dt><code>vxlan</code></dt>
1238 An Ethernet tunnel over the experimental, UDP-based VXLAN
1239 protocol described at
1240 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-02</code>.
1241 VXLAN is currently supported only with the Linux kernel datapath
1242 with kernel version 2.6.26 or later.
1245 As an experimental protocol, VXLAN has no officially assigned UDP
1246 port. Open vSwitch currently uses UDP destination port 8472.
1247 The source port used for VXLAN traffic varies on a per-flow basis
1248 and is in the ephemeral port range.
1252 <dt><code>patch</code></dt>
1254 A pair of virtual devices that act as a patch cable.
1257 <dt><code>null</code></dt>
1258 <dd>An ignored interface. Deprecated and slated for removal in
1264 <group title="Tunnel Options">
1266 These options apply to interfaces with <ref column="type"/> of
1267 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1268 <code>ipsec_gre64</code>, and <code>vxlan</code>.
1272 Each tunnel must be uniquely identified by the combination of <ref
1273 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1274 column="options" key="local_ip"/>, and <ref column="options"
1275 key="in_key"/>. If two ports are defined that are the same except one
1276 has an optional identifier and the other does not, the more specific
1277 one is matched first. <ref column="options" key="in_key"/> is
1278 considered more specific than <ref column="options" key="local_ip"/> if
1279 a port defines one and another port defines the other.
1282 <column name="options" key="remote_ip">
1284 Required. The tunnel endpoint. Unicast and multicast endpoints are
1289 When a multicast endpoint is specified, a routing table lookup occurs
1290 only when the tunnel is created. Following a routing change, delete
1291 and then re-create the tunnel to force a new routing table lookup.
1295 <column name="options" key="local_ip">
1296 Optional. The destination IP that received packets must match.
1297 Default is to match all addresses. Must be omitted when <ref
1298 column="options" key="remote_ip"/> is a multicast address.
1301 <column name="options" key="in_key">
1302 <p>Optional. The key that received packets must contain, one of:</p>
1306 <code>0</code>. The tunnel receives packets with no key or with a
1307 key of 0. This is equivalent to specifying no <ref column="options"
1308 key="in_key"/> at all.
1311 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1312 GRE64) number. The tunnel receives only packets with the
1316 The word <code>flow</code>. The tunnel accepts packets with any
1317 key. The key will be placed in the <code>tun_id</code> field for
1318 matching in the flow table. The <code>ovs-ofctl</code> manual page
1319 contains additional information about matching fields in OpenFlow
1328 <column name="options" key="out_key">
1329 <p>Optional. The key to be set on outgoing packets, one of:</p>
1333 <code>0</code>. Packets sent through the tunnel will have no key.
1334 This is equivalent to specifying no <ref column="options"
1335 key="out_key"/> at all.
1338 A positive 24-bit (for VXLAN), 32-bit (for GRE) or 64-bit (for
1339 GRE64) number. Packets sent through the tunnel will have the
1343 The word <code>flow</code>. Packets sent through the tunnel will
1344 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1345 vendor extension (0 is used in the absence of an action). The
1346 <code>ovs-ofctl</code> manual page contains additional information
1347 about the Nicira OpenFlow vendor extensions.
1352 <column name="options" key="key">
1353 Optional. Shorthand to set <code>in_key</code> and
1354 <code>out_key</code> at the same time.
1357 <column name="options" key="tos">
1358 Optional. The value of the ToS bits to be set on the encapsulating
1359 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1360 zero. It may also be the word <code>inherit</code>, in which case
1361 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1362 (otherwise it will be 0). The ECN fields are always inherited.
1366 <column name="options" key="ttl">
1367 Optional. The TTL to be set on the encapsulating packet. It may also
1368 be the word <code>inherit</code>, in which case the TTL will be copied
1369 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1370 system default, typically 64). Default is the system default TTL.
1373 <column name="options" key="df_default"
1374 type='{"type": "boolean"}'>
1375 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1376 outer headers to allow path MTU discovery. Default is enabled; set
1377 to <code>false</code> to disable.
1380 <group title="Tunnel Options: gre and ipsec_gre only">
1382 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1386 <column name="options" key="csum" type='{"type": "boolean"}'>
1388 Optional. Compute GRE checksums on outgoing packets. Default is
1389 disabled, set to <code>true</code> to enable. Checksums present on
1390 incoming packets will be validated regardless of this setting.
1394 GRE checksums impose a significant performance penalty because they
1395 cover the entire packet. The encapsulated L3, L4, and L7 packet
1396 contents typically have their own checksums, so this additional
1397 checksum only adds value for the GRE and encapsulated L2 headers.
1401 This option is supported for <code>ipsec_gre</code>, but not useful
1402 because GRE checksums are weaker than, and redundant with, IPsec
1403 payload authentication.
1408 <group title="Tunnel Options: ipsec_gre only">
1410 Only <code>ipsec_gre</code> interfaces support these options.
1413 <column name="options" key="peer_cert">
1414 Required for certificate authentication. A string containing the
1415 peer's certificate in PEM format. Additionally the host's
1416 certificate must be specified with the <code>certificate</code>
1420 <column name="options" key="certificate">
1421 Required for certificate authentication. The name of a PEM file
1422 containing a certificate that will be presented to the peer during
1426 <column name="options" key="private_key">
1427 Optional for certificate authentication. The name of a PEM file
1428 containing the private key associated with <code>certificate</code>.
1429 If <code>certificate</code> contains the private key, this option may
1433 <column name="options" key="psk">
1434 Required for pre-shared key authentication. Specifies a pre-shared
1435 key for authentication that must be identical on both sides of the
1441 <group title="Patch Options">
1443 Only <code>patch</code> interfaces support these options.
1446 <column name="options" key="peer">
1447 The <ref column="name"/> of the <ref table="Interface"/> for the other
1448 side of the patch. The named <ref table="Interface"/>'s own
1449 <code>peer</code> option must specify this <ref table="Interface"/>'s
1450 name. That is, the two patch interfaces must have reversed <ref
1451 column="name"/> and <code>peer</code> values.
1455 <group title="Interface Status">
1457 Status information about interfaces attached to bridges, updated every
1458 5 seconds. Not all interfaces have all of these properties; virtual
1459 interfaces don't have a link speed, for example. Non-applicable
1460 columns will have empty values.
1462 <column name="admin_state">
1464 The administrative state of the physical network link.
1468 <column name="link_state">
1470 The observed state of the physical network link. This is ordinarily
1471 the link's carrier status. If the interface's <ref table="Port"/> is
1472 a bond configured for miimon monitoring, it is instead the network
1473 link's miimon status.
1477 <column name="link_resets">
1479 The number of times Open vSwitch has observed the
1480 <ref column="link_state"/> of this <ref table="Interface"/> change.
1484 <column name="link_speed">
1486 The negotiated speed of the physical network link.
1487 Valid values are positive integers greater than 0.
1491 <column name="duplex">
1493 The duplex mode of the physical network link.
1499 The MTU (maximum transmission unit); i.e. the largest
1500 amount of data that can fit into a single Ethernet frame.
1501 The standard Ethernet MTU is 1500 bytes. Some physical media
1502 and many kinds of virtual interfaces can be configured with
1506 This column will be empty for an interface that does not
1507 have an MTU as, for example, some kinds of tunnels do not.
1511 <column name="lacp_current">
1512 Boolean value indicating LACP status for this interface. If true, this
1513 interface has current LACP information about its LACP partner. This
1514 information may be used to monitor the health of interfaces in a LACP
1515 enabled port. This column will be empty if LACP is not enabled.
1518 <column name="status">
1519 Key-value pairs that report port status. Supported status values are
1520 <ref column="type"/>-dependent; some interfaces may not have a valid
1521 <ref column="status" key="driver_name"/>, for example.
1524 <column name="status" key="driver_name">
1525 The name of the device driver controlling the network adapter.
1528 <column name="status" key="driver_version">
1529 The version string of the device driver controlling the network
1533 <column name="status" key="firmware_version">
1534 The version string of the network adapter's firmware, if available.
1537 <column name="status" key="source_ip">
1538 The source IP address used for an IPv4 tunnel end-point, such as
1542 <column name="status" key="tunnel_egress_iface">
1543 Egress interface for tunnels. Currently only relevant for GRE tunnels
1544 On Linux systems, this column will show the name of the interface
1545 which is responsible for routing traffic destined for the configured
1546 <ref column="options" key="remote_ip"/>. This could be an internal
1547 interface such as a bridge port.
1550 <column name="status" key="tunnel_egress_iface_carrier"
1551 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1552 Whether carrier is detected on <ref column="status"
1553 key="tunnel_egress_iface"/>.
1557 <group title="Statistics">
1559 Key-value pairs that report interface statistics. The current
1560 implementation updates these counters periodically. Future
1561 implementations may update them when an interface is created, when they
1562 are queried (e.g. using an OVSDB <code>select</code> operation), and
1563 just before an interface is deleted due to virtual interface hot-unplug
1564 or VM shutdown, and perhaps at other times, but not on any regular
1568 These are the same statistics reported by OpenFlow in its <code>struct
1569 ofp_port_stats</code> structure. If an interface does not support a
1570 given statistic, then that pair is omitted.
1572 <group title="Statistics: Successful transmit and receive counters">
1573 <column name="statistics" key="rx_packets">
1574 Number of received packets.
1576 <column name="statistics" key="rx_bytes">
1577 Number of received bytes.
1579 <column name="statistics" key="tx_packets">
1580 Number of transmitted packets.
1582 <column name="statistics" key="tx_bytes">
1583 Number of transmitted bytes.
1586 <group title="Statistics: Receive errors">
1587 <column name="statistics" key="rx_dropped">
1588 Number of packets dropped by RX.
1590 <column name="statistics" key="rx_frame_err">
1591 Number of frame alignment errors.
1593 <column name="statistics" key="rx_over_err">
1594 Number of packets with RX overrun.
1596 <column name="statistics" key="rx_crc_err">
1597 Number of CRC errors.
1599 <column name="statistics" key="rx_errors">
1600 Total number of receive errors, greater than or equal to the sum of
1604 <group title="Statistics: Transmit errors">
1605 <column name="statistics" key="tx_dropped">
1606 Number of packets dropped by TX.
1608 <column name="statistics" key="collisions">
1609 Number of collisions.
1611 <column name="statistics" key="tx_errors">
1612 Total number of transmit errors, greater than or equal to the sum of
1618 <group title="Ingress Policing">
1620 These settings control ingress policing for packets received on this
1621 interface. On a physical interface, this limits the rate at which
1622 traffic is allowed into the system from the outside; on a virtual
1623 interface (one connected to a virtual machine), this limits the rate at
1624 which the VM is able to transmit.
1627 Policing is a simple form of quality-of-service that simply drops
1628 packets received in excess of the configured rate. Due to its
1629 simplicity, policing is usually less accurate and less effective than
1630 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1631 table="Queue"/> tables).
1634 Policing is currently implemented only on Linux. The Linux
1635 implementation uses a simple ``token bucket'' approach:
1639 The size of the bucket corresponds to <ref
1640 column="ingress_policing_burst"/>. Initially the bucket is full.
1643 Whenever a packet is received, its size (converted to tokens) is
1644 compared to the number of tokens currently in the bucket. If the
1645 required number of tokens are available, they are removed and the
1646 packet is forwarded. Otherwise, the packet is dropped.
1649 Whenever it is not full, the bucket is refilled with tokens at the
1650 rate specified by <ref column="ingress_policing_rate"/>.
1654 Policing interacts badly with some network protocols, and especially
1655 with fragmented IP packets. Suppose that there is enough network
1656 activity to keep the bucket nearly empty all the time. Then this token
1657 bucket algorithm will forward a single packet every so often, with the
1658 period depending on packet size and on the configured rate. All of the
1659 fragments of an IP packets are normally transmitted back-to-back, as a
1660 group. In such a situation, therefore, only one of these fragments
1661 will be forwarded and the rest will be dropped. IP does not provide
1662 any way for the intended recipient to ask for only the remaining
1663 fragments. In such a case there are two likely possibilities for what
1664 will happen next: either all of the fragments will eventually be
1665 retransmitted (as TCP will do), in which case the same problem will
1666 recur, or the sender will not realize that its packet has been dropped
1667 and data will simply be lost (as some UDP-based protocols will do).
1668 Either way, it is possible that no forward progress will ever occur.
1670 <column name="ingress_policing_rate">
1672 Maximum rate for data received on this interface, in kbps. Data
1673 received faster than this rate is dropped. Set to <code>0</code>
1674 (the default) to disable policing.
1678 <column name="ingress_policing_burst">
1679 <p>Maximum burst size for data received on this interface, in kb. The
1680 default burst size if set to <code>0</code> is 1000 kb. This value
1681 has no effect if <ref column="ingress_policing_rate"/>
1682 is <code>0</code>.</p>
1684 Specifying a larger burst size lets the algorithm be more forgiving,
1685 which is important for protocols like TCP that react severely to
1686 dropped packets. The burst size should be at least the size of the
1687 interface's MTU. Specifying a value that is numerically at least as
1688 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1689 closer to achieving the full rate.
1694 <group title="Connectivity Fault Management">
1696 802.1ag Connectivity Fault Management (CFM) allows a group of
1697 Maintenance Points (MPs) called a Maintenance Association (MA) to
1698 detect connectivity problems with each other. MPs within a MA should
1699 have complete and exclusive interconnectivity. This is verified by
1700 occasionally broadcasting Continuity Check Messages (CCMs) at a
1701 configurable transmission interval.
1705 According to the 802.1ag specification, each Maintenance Point should
1706 be configured out-of-band with a list of Remote Maintenance Points it
1707 should have connectivity to. Open vSwitch differs from the
1708 specification in this area. It simply assumes the link is faulted if
1709 no Remote Maintenance Points are reachable, and considers it not
1714 When operating over tunnels which have no <code>in_key</code>, or an
1715 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1716 with a tunnel key of zero.
1719 <column name="cfm_mpid">
1720 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1721 a Maintenance Association. The MPID is used to identify this endpoint
1722 to other Maintenance Points in the MA. Each end of a link being
1723 monitored should have a different MPID. Must be configured to enable
1724 CFM on this <ref table="Interface"/>.
1727 <column name="cfm_fault">
1729 Indicates a connectivity fault triggered by an inability to receive
1730 heartbeats from any remote endpoint. When a fault is triggered on
1731 <ref table="Interface"/>s participating in bonds, they will be
1735 Faults can be triggered for several reasons. Most importantly they
1736 are triggered when no CCMs are received for a period of 3.5 times the
1737 transmission interval. Faults are also triggered when any CCMs
1738 indicate that a Remote Maintenance Point is not receiving CCMs but
1739 able to send them. Finally, a fault is triggered if a CCM is
1740 received which indicates unexpected configuration. Notably, this
1741 case arises when a CCM is received which advertises the local MPID.
1745 <column name="cfm_fault_status" key="recv">
1746 Indicates a CFM fault was triggered due to a lack of CCMs received on
1747 the <ref table="Interface"/>.
1750 <column name="cfm_fault_status" key="rdi">
1751 Indicates a CFM fault was triggered due to the reception of a CCM with
1752 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1753 are not receiving CCMs themselves. This typically indicates a
1754 unidirectional connectivity failure.
1757 <column name="cfm_fault_status" key="maid">
1758 Indicates a CFM fault was triggered due to the reception of a CCM with
1759 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1760 with an identification number in addition to the MPID called the MAID.
1761 Open vSwitch only supports receiving CCM broadcasts tagged with the
1762 MAID it uses internally.
1765 <column name="cfm_fault_status" key="loopback">
1766 Indicates a CFM fault was triggered due to the reception of a CCM
1767 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1768 column of this <ref table="Interface"/>. This may indicate a loop in
1772 <column name="cfm_fault_status" key="overflow">
1773 Indicates a CFM fault was triggered because the CFM module received
1774 CCMs from more remote endpoints than it can keep track of.
1777 <column name="cfm_fault_status" key="override">
1778 Indicates a CFM fault was manually triggered by an administrator using
1779 an <code>ovs-appctl</code> command.
1782 <column name="cfm_fault_status" key="interval">
1783 Indicates a CFM fault was triggered due to the reception of a CCM
1784 frame having an invalid interval.
1787 <column name="cfm_remote_opstate">
1788 <p>When in extended mode, indicates the operational state of the
1789 remote endpoint as either <code>up</code> or <code>down</code>. See
1790 <ref column="other_config" key="cfm_opstate"/>.
1794 <column name="cfm_health">
1796 Indicates the health of the interface as a percentage of CCM frames
1797 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1798 The health of an interface is undefined if it is communicating with
1799 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1800 healthy heartbeats are not received at the expected rate, and
1801 gradually improves as healthy heartbeats are received at the desired
1802 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1803 health of the interface is refreshed.
1806 As mentioned above, the faults can be triggered for several reasons.
1807 The link health will deteriorate even if heartbeats are received but
1808 they are reported to be unhealthy. An unhealthy heartbeat in this
1809 context is a heartbeat for which either some fault is set or is out
1810 of sequence. The interface health can be 100 only on receiving
1811 healthy heartbeats at the desired rate.
1815 <column name="cfm_remote_mpids">
1816 When CFM is properly configured, Open vSwitch will occasionally
1817 receive CCM broadcasts. These broadcasts contain the MPID of the
1818 sending Maintenance Point. The list of MPIDs from which this
1819 <ref table="Interface"/> is receiving broadcasts from is regularly
1820 collected and written to this column.
1823 <column name="other_config" key="cfm_interval"
1824 type='{"type": "integer"}'>
1826 The interval, in milliseconds, between transmissions of CFM
1827 heartbeats. Three missed heartbeat receptions indicate a
1832 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1833 60,000, or 600,000 ms are supported. Other values will be rounded
1834 down to the nearest value on the list. Extended mode (see <ref
1835 column="other_config" key="cfm_extended"/>) supports any interval up
1836 to 65,535 ms. In either mode, the default is 1000 ms.
1839 <p>We do not recommend using intervals less than 100 ms.</p>
1842 <column name="other_config" key="cfm_extended"
1843 type='{"type": "boolean"}'>
1844 When <code>true</code>, the CFM module operates in extended mode. This
1845 causes it to use a nonstandard destination address to avoid conflicting
1846 with compliant implementations which may be running concurrently on the
1847 network. Furthermore, extended mode increases the accuracy of the
1848 <code>cfm_interval</code> configuration parameter by breaking wire
1849 compatibility with 802.1ag compliant implementations. Defaults to
1852 <column name="other_config" key="cfm_opstate"
1853 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1854 When <code>down</code>, the CFM module marks all CCMs it generates as
1855 operationally down without triggering a fault. This allows remote
1856 maintenance points to choose not to forward traffic to the
1857 <ref table="Interface"/> on which this CFM module is running.
1858 Currently, in Open vSwitch, the opdown bit of CCMs affects
1859 <ref table="Interface"/>s participating in bonds, and the bundle
1860 OpenFlow action. This setting is ignored when CFM is not in extended
1861 mode. Defaults to <code>up</code>.
1864 <column name="other_config" key="cfm_ccm_vlan"
1865 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1866 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1867 with the given value. May be the string <code>random</code> in which
1868 case each CCM will be tagged with a different randomly generated VLAN.
1871 <column name="other_config" key="cfm_ccm_pcp"
1872 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1873 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1874 with the given PCP value, the VLAN ID of the tag is governed by the
1875 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1876 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1882 <group title="Bonding Configuration">
1883 <column name="other_config" key="lacp-port-id"
1884 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1885 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1886 used in LACP negotiations to identify individual ports
1887 participating in a bond.
1890 <column name="other_config" key="lacp-port-priority"
1891 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1892 The LACP port priority of this <ref table="Interface"/>. In LACP
1893 negotiations <ref table="Interface"/>s with numerically lower
1894 priorities are preferred for aggregation.
1897 <column name="other_config" key="lacp-aggregation-key"
1898 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1899 The LACP aggregation key of this <ref table="Interface"/>. <ref
1900 table="Interface"/>s with different aggregation keys may not be active
1901 within a given <ref table="Port"/> at the same time.
1905 <group title="Virtual Machine Identifiers">
1907 These key-value pairs specifically apply to an interface that
1908 represents a virtual Ethernet interface connected to a virtual
1909 machine. These key-value pairs should not be present for other types
1910 of interfaces. Keys whose names end in <code>-uuid</code> have
1911 values that uniquely identify the entity in question. For a Citrix
1912 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1913 Other hypervisors may use other formats.
1916 <column name="external_ids" key="attached-mac">
1917 The MAC address programmed into the ``virtual hardware'' for this
1918 interface, in the form
1919 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1920 For Citrix XenServer, this is the value of the <code>MAC</code> field
1921 in the VIF record for this interface.
1924 <column name="external_ids" key="iface-id">
1925 A system-unique identifier for the interface. On XenServer, this will
1926 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1929 <column name="external_ids" key="iface-status"
1930 type='{"type": "string",
1931 "enum": ["set", ["active", "inactive"]]}'>
1933 Hypervisors may sometimes have more than one interface associated
1934 with a given <ref column="external_ids" key="iface-id"/>, only one of
1935 which is actually in use at a given time. For example, in some
1936 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1937 for a single <ref column="external_ids" key="iface-id"/>, but only
1938 uses one of them at a time. A hypervisor that behaves this way must
1939 mark the currently in use interface <code>active</code> and the
1940 others <code>inactive</code>. A hypervisor that never has more than
1941 one interface for a given <ref column="external_ids" key="iface-id"/>
1942 may mark that interface <code>active</code> or omit <ref
1943 column="external_ids" key="iface-status"/> entirely.
1947 During VM migration, a given <ref column="external_ids"
1948 key="iface-id"/> might transiently be marked <code>active</code> on
1949 two different hypervisors. That is, <code>active</code> means that
1950 this <ref column="external_ids" key="iface-id"/> is the active
1951 instance within a single hypervisor, not in a broader scope.
1955 <column name="external_ids" key="xs-vif-uuid">
1956 The virtual interface associated with this interface.
1959 <column name="external_ids" key="xs-network-uuid">
1960 The virtual network to which this interface is attached.
1963 <column name="external_ids" key="vm-id">
1964 The VM to which this interface belongs. On XenServer, this will be the
1965 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1968 <column name="external_ids" key="xs-vm-uuid">
1969 The VM to which this interface belongs.
1973 <group title="VLAN Splinters">
1975 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1976 with buggy network drivers in old versions of Linux that do not
1977 properly support VLANs when VLAN devices are not used, at some cost
1978 in memory and performance.
1982 When VLAN splinters are enabled on a particular interface, Open vSwitch
1983 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1984 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1985 received on the VLAN device is treated as if it had been received on
1986 the interface on the particular VLAN.
1990 VLAN splinters consider a VLAN to be in use if:
1995 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1996 table="Port"/> record.
2000 The VLAN is listed within the <ref table="Port" column="trunks"/>
2001 column of the <ref table="Port"/> record of an interface on which
2002 VLAN splinters are enabled.
2004 An empty <ref table="Port" column="trunks"/> does not influence the
2005 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2006 will exceed the current 1,024 port per datapath limit.
2010 An OpenFlow flow within any bridge matches the VLAN.
2015 The same set of in-use VLANs applies to every interface on which VLAN
2016 splinters are enabled. That is, the set is not chosen separately for
2017 each interface but selected once as the union of all in-use VLANs based
2022 It does not make sense to enable VLAN splinters on an interface for an
2023 access port, or on an interface that is not a physical port.
2027 VLAN splinters are deprecated. When broken device drivers are no
2028 longer in widespread use, we will delete this feature.
2031 <column name="other_config" key="enable-vlan-splinters"
2032 type='{"type": "boolean"}'>
2034 Set to <code>true</code> to enable VLAN splinters on this interface.
2035 Defaults to <code>false</code>.
2039 VLAN splinters increase kernel and userspace memory overhead, so do
2040 not use them unless they are needed.
2044 VLAN splinters do not support 802.1p priority tags. Received
2045 priorities will appear to be 0, regardless of their actual values,
2046 and priorities on transmitted packets will also be cleared to 0.
2051 <group title="Common Columns">
2052 The overall purpose of these columns is described under <code>Common
2053 Columns</code> at the beginning of this document.
2055 <column name="other_config"/>
2056 <column name="external_ids"/>
2060 <table name="Flow_Table" title="OpenFlow table configuration">
2061 <p>Configuration for a particular OpenFlow table.</p>
2063 <column name="name">
2064 The table's name. Set this column to change the name that controllers
2065 will receive when they request table statistics, e.g. <code>ovs-ofctl
2066 dump-tables</code>. The name does not affect switch behavior.
2069 <column name="flow_limit">
2070 If set, limits the number of flows that may be added to the table. Open
2071 vSwitch may limit the number of flows in a table for other reasons,
2072 e.g. due to hardware limitations or for resource availability or
2073 performance reasons.
2076 <column name="overflow_policy">
2078 Controls the switch's behavior when an OpenFlow flow table modification
2079 request would add flows in excess of <ref column="flow_limit"/>. The
2080 supported values are:
2084 <dt><code>refuse</code></dt>
2086 Refuse to add the flow or flows. This is also the default policy
2087 when <ref column="overflow_policy"/> is unset.
2090 <dt><code>evict</code></dt>
2092 Delete the flow that will expire soonest. See <ref column="groups"/>
2098 <column name="groups">
2100 When <ref column="overflow_policy"/> is <code>evict</code>, this
2101 controls how flows are chosen for eviction when the flow table would
2102 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2103 of NXM fields or sub-fields, each of which takes one of the forms
2104 <code><var>field</var>[]</code> or
2105 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2106 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2107 <code>nicira-ext.h</code> for a complete list of NXM field names.
2111 When a flow must be evicted due to overflow, the flow to evict is
2112 chosen through an approximation of the following algorithm:
2117 Divide the flows in the table into groups based on the values of the
2118 specified fields or subfields, so that all of the flows in a given
2119 group have the same values for those fields. If a flow does not
2120 specify a given field, that field's value is treated as 0.
2124 Consider the flows in the largest group, that is, the group that
2125 contains the greatest number of flows. If two or more groups all
2126 have the same largest number of flows, consider the flows in all of
2131 Among the flows under consideration, choose the flow that expires
2132 soonest for eviction.
2137 The eviction process only considers flows that have an idle timeout or
2138 a hard timeout. That is, eviction never deletes permanent flows.
2139 (Permanent flows do count against <ref column="flow_limit"/>.)
2143 Open vSwitch ignores any invalid or unknown field specifications.
2147 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2148 column has no effect.
2153 <table name="QoS" title="Quality of Service configuration">
2154 <p>Quality of Service (QoS) configuration for each Port that
2157 <column name="type">
2158 <p>The type of QoS to implement. The currently defined types are
2161 <dt><code>linux-htb</code></dt>
2163 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2164 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2165 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2166 for information on how this classifier works and how to configure it.
2170 <dt><code>linux-hfsc</code></dt>
2172 Linux "Hierarchical Fair Service Curve" classifier.
2173 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2174 information on how this classifier works.
2179 <column name="queues">
2180 <p>A map from queue numbers to <ref table="Queue"/> records. The
2181 supported range of queue numbers depend on <ref column="type"/>. The
2182 queue numbers are the same as the <code>queue_id</code> used in
2183 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2187 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2188 actions when no specific queue has been set. When no configuration for
2189 queue 0 is present, it is automatically configured as if a <ref
2190 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2191 and <ref table="Queue" column="other_config"/> columns had been
2193 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2194 this case. With some queuing disciplines, this dropped all packets
2195 destined for the default queue.)
2199 <group title="Configuration for linux-htb and linux-hfsc">
2201 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2202 the following key-value pair:
2205 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2206 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2207 specified, for physical interfaces, the default is the link rate. For
2208 other interfaces or if the link rate cannot be determined, the default
2209 is currently 100 Mbps.
2213 <group title="Common Columns">
2214 The overall purpose of these columns is described under <code>Common
2215 Columns</code> at the beginning of this document.
2217 <column name="other_config"/>
2218 <column name="external_ids"/>
2222 <table name="Queue" title="QoS output queue.">
2223 <p>A configuration for a port output queue, used in configuring Quality of
2224 Service (QoS) features. May be referenced by <ref column="queues"
2225 table="QoS"/> column in <ref table="QoS"/> table.</p>
2227 <column name="dscp">
2228 If set, Open vSwitch will mark all traffic egressing this
2229 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2230 default <ref table="Queue"/> is only marked if it was explicitly selected
2231 as the <ref table="Queue"/> at the time the packet was output. If unset,
2232 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2236 <group title="Configuration for linux-htb QoS">
2238 <ref table="QoS"/> <ref table="QoS" column="type"/>
2239 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2240 It has the following key-value pairs defined.
2243 <column name="other_config" key="min-rate"
2244 type='{"type": "integer", "minInteger": 1}'>
2245 Minimum guaranteed bandwidth, in bit/s.
2248 <column name="other_config" key="max-rate"
2249 type='{"type": "integer", "minInteger": 1}'>
2250 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2251 queue's rate will not be allowed to exceed the specified value, even
2252 if excess bandwidth is available. If unspecified, defaults to no
2256 <column name="other_config" key="burst"
2257 type='{"type": "integer", "minInteger": 1}'>
2258 Burst size, in bits. This is the maximum amount of ``credits'' that a
2259 queue can accumulate while it is idle. Optional. Details of the
2260 <code>linux-htb</code> implementation require a minimum burst size, so
2261 a too-small <code>burst</code> will be silently ignored.
2264 <column name="other_config" key="priority"
2265 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2266 A queue with a smaller <code>priority</code> will receive all the
2267 excess bandwidth that it can use before a queue with a larger value
2268 receives any. Specific priority values are unimportant; only relative
2269 ordering matters. Defaults to 0 if unspecified.
2273 <group title="Configuration for linux-hfsc QoS">
2275 <ref table="QoS"/> <ref table="QoS" column="type"/>
2276 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2277 It has the following key-value pairs defined.
2280 <column name="other_config" key="min-rate"
2281 type='{"type": "integer", "minInteger": 1}'>
2282 Minimum guaranteed bandwidth, in bit/s.
2285 <column name="other_config" key="max-rate"
2286 type='{"type": "integer", "minInteger": 1}'>
2287 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2288 queue's rate will not be allowed to exceed the specified value, even if
2289 excess bandwidth is available. If unspecified, defaults to no
2294 <group title="Common Columns">
2295 The overall purpose of these columns is described under <code>Common
2296 Columns</code> at the beginning of this document.
2298 <column name="other_config"/>
2299 <column name="external_ids"/>
2303 <table name="Mirror" title="Port mirroring.">
2304 <p>A port mirror within a <ref table="Bridge"/>.</p>
2305 <p>A port mirror configures a bridge to send selected frames to special
2306 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2307 traffic may also be referred to as SPAN or RSPAN, depending on how
2308 the mirrored traffic is sent.</p>
2310 <column name="name">
2311 Arbitrary identifier for the <ref table="Mirror"/>.
2314 <group title="Selecting Packets for Mirroring">
2316 To be selected for mirroring, a given packet must enter or leave the
2317 bridge through a selected port and it must also be in one of the
2321 <column name="select_all">
2322 If true, every packet arriving or departing on any port is
2323 selected for mirroring.
2326 <column name="select_dst_port">
2327 Ports on which departing packets are selected for mirroring.
2330 <column name="select_src_port">
2331 Ports on which arriving packets are selected for mirroring.
2334 <column name="select_vlan">
2335 VLANs on which packets are selected for mirroring. An empty set
2336 selects packets on all VLANs.
2340 <group title="Mirroring Destination Configuration">
2342 These columns are mutually exclusive. Exactly one of them must be
2346 <column name="output_port">
2347 <p>Output port for selected packets, if nonempty.</p>
2348 <p>Specifying a port for mirror output reserves that port exclusively
2349 for mirroring. No frames other than those selected for mirroring
2351 will be forwarded to the port, and any frames received on the port
2352 will be discarded.</p>
2354 The output port may be any kind of port supported by Open vSwitch.
2355 It may be, for example, a physical port (sometimes called SPAN) or a
2360 <column name="output_vlan">
2361 <p>Output VLAN for selected packets, if nonempty.</p>
2362 <p>The frames will be sent out all ports that trunk
2363 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2364 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2365 trunk port, the frame's VLAN tag will be set to
2366 <ref column="output_vlan"/>, replacing any existing tag; when it is
2367 sent out an implicit VLAN port, the frame will not be tagged. This
2368 type of mirroring is sometimes called RSPAN.</p>
2370 See the documentation for
2371 <ref column="other_config" key="forward-bpdu"/> in the
2372 <ref table="Interface"/> table for a list of destination MAC
2373 addresses which will not be mirrored to a VLAN to avoid confusing
2374 switches that interpret the protocols that they represent.
2376 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2377 contains unmanaged switches. Consider an unmanaged physical switch
2378 with two ports: port 1, connected to an end host, and port 2,
2379 connected to an Open vSwitch configured to mirror received packets
2380 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2381 port 1 that the physical switch forwards to port 2. The Open vSwitch
2382 forwards this packet to its destination and then reflects it back on
2383 port 2 in VLAN 123. This reflected packet causes the unmanaged
2384 physical switch to replace the MAC learning table entry, which
2385 correctly pointed to port 1, with one that incorrectly points to port
2386 2. Afterward, the physical switch will direct packets destined for
2387 the end host to the Open vSwitch on port 2, instead of to the end
2388 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2389 desired in this scenario, then the physical switch must be replaced
2390 by one that learns Ethernet addresses on a per-VLAN basis. In
2391 addition, learning should be disabled on the VLAN containing mirrored
2392 traffic. If this is not done then intermediate switches will learn
2393 the MAC address of each end host from the mirrored traffic. If
2394 packets being sent to that end host are also mirrored, then they will
2395 be dropped since the switch will attempt to send them out the input
2396 port. Disabling learning for the VLAN will cause the switch to
2397 correctly send the packet out all ports configured for that VLAN. If
2398 Open vSwitch is being used as an intermediate switch, learning can be
2399 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2400 in the appropriate <ref table="Bridge"/> table or tables.</p>
2402 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2403 VLAN and should generally be preferred.
2408 <group title="Statistics: Mirror counters">
2410 Key-value pairs that report mirror statistics.
2412 <column name="statistics" key="tx_packets">
2413 Number of packets transmitted through this mirror.
2415 <column name="statistics" key="tx_bytes">
2416 Number of bytes transmitted through this mirror.
2420 <group title="Common Columns">
2421 The overall purpose of these columns is described under <code>Common
2422 Columns</code> at the beginning of this document.
2424 <column name="external_ids"/>
2428 <table name="Controller" title="OpenFlow controller configuration.">
2429 <p>An OpenFlow controller.</p>
2432 Open vSwitch supports two kinds of OpenFlow controllers:
2436 <dt>Primary controllers</dt>
2439 This is the kind of controller envisioned by the OpenFlow 1.0
2440 specification. Usually, a primary controller implements a network
2441 policy by taking charge of the switch's flow table.
2445 Open vSwitch initiates and maintains persistent connections to
2446 primary controllers, retrying the connection each time it fails or
2447 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2448 <ref table="Bridge"/> table applies to primary controllers.
2452 Open vSwitch permits a bridge to have any number of primary
2453 controllers. When multiple controllers are configured, Open
2454 vSwitch connects to all of them simultaneously. Because
2455 OpenFlow 1.0 does not specify how multiple controllers
2456 coordinate in interacting with a single switch, more than
2457 one primary controller should be specified only if the
2458 controllers are themselves designed to coordinate with each
2459 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2460 vendor extension may be useful for this.)
2463 <dt>Service controllers</dt>
2466 These kinds of OpenFlow controller connections are intended for
2467 occasional support and maintenance use, e.g. with
2468 <code>ovs-ofctl</code>. Usually a service controller connects only
2469 briefly to inspect or modify some of a switch's state.
2473 Open vSwitch listens for incoming connections from service
2474 controllers. The service controllers initiate and, if necessary,
2475 maintain the connections from their end. The <ref table="Bridge"
2476 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2477 not apply to service controllers.
2481 Open vSwitch supports configuring any number of service controllers.
2487 The <ref column="target"/> determines the type of controller.
2490 <group title="Core Features">
2491 <column name="target">
2492 <p>Connection method for controller.</p>
2494 The following connection methods are currently supported for primary
2498 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2500 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2501 the given <var>ip</var>, which must be expressed as an IP address
2502 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2503 column in the <ref table="Open_vSwitch"/> table must point to a
2504 valid SSL configuration when this form is used.</p>
2505 <p>SSL support is an optional feature that is not always built as
2506 part of Open vSwitch.</p>
2508 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2509 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2510 the given <var>ip</var>, which must be expressed as an IP address
2511 (not a DNS name).</dd>
2514 The following connection methods are currently supported for service
2518 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2521 Listens for SSL connections on the specified TCP <var>port</var>
2522 (default: 6633). If <var>ip</var>, which must be expressed as an
2523 IP address (not a DNS name), is specified, then connections are
2524 restricted to the specified local IP address.
2527 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2528 table="Open_vSwitch"/> table must point to a valid SSL
2529 configuration when this form is used.
2531 <p>SSL support is an optional feature that is not always built as
2532 part of Open vSwitch.</p>
2534 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2536 Listens for connections on the specified TCP <var>port</var>
2537 (default: 6633). If <var>ip</var>, which must be expressed as an
2538 IP address (not a DNS name), is specified, then connections are
2539 restricted to the specified local IP address.
2542 <p>When multiple controllers are configured for a single bridge, the
2543 <ref column="target"/> values must be unique. Duplicate
2544 <ref column="target"/> values yield unspecified results.</p>
2547 <column name="connection_mode">
2548 <p>If it is specified, this setting must be one of the following
2549 strings that describes how Open vSwitch contacts this OpenFlow
2550 controller over the network:</p>
2553 <dt><code>in-band</code></dt>
2554 <dd>In this mode, this controller's OpenFlow traffic travels over the
2555 bridge associated with the controller. With this setting, Open
2556 vSwitch allows traffic to and from the controller regardless of the
2557 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2558 would never be able to connect to the controller, because it did
2559 not have a flow to enable it.) This is the most common connection
2560 mode because it is not necessary to maintain two independent
2562 <dt><code>out-of-band</code></dt>
2563 <dd>In this mode, OpenFlow traffic uses a control network separate
2564 from the bridge associated with this controller, that is, the
2565 bridge does not use any of its own network devices to communicate
2566 with the controller. The control network must be configured
2567 separately, before or after <code>ovs-vswitchd</code> is started.
2571 <p>If not specified, the default is implementation-specific.</p>
2575 <group title="Controller Failure Detection and Handling">
2576 <column name="max_backoff">
2577 Maximum number of milliseconds to wait between connection attempts.
2578 Default is implementation-specific.
2581 <column name="inactivity_probe">
2582 Maximum number of milliseconds of idle time on connection to
2583 controller before sending an inactivity probe message. If Open
2584 vSwitch does not communicate with the controller for the specified
2585 number of seconds, it will send a probe. If a response is not
2586 received for the same additional amount of time, Open vSwitch
2587 assumes the connection has been broken and attempts to reconnect.
2588 Default is implementation-specific. A value of 0 disables
2593 <group title="Asynchronous Message Configuration">
2595 OpenFlow switches send certain messages to controllers spontanenously,
2596 that is, not in response to any request from the controller. These
2597 messages are called ``asynchronous messages.'' These columns allow
2598 asynchronous messages to be limited or disabled to ensure the best use
2599 of network resources.
2602 <column name="enable_async_messages">
2603 The OpenFlow protocol enables asynchronous messages at time of
2604 connection establishment, which means that a controller can receive
2605 asynchronous messages, potentially many of them, even if it turns them
2606 off immediately after connecting. Set this column to
2607 <code>false</code> to change Open vSwitch behavior to disable, by
2608 default, all asynchronous messages. The controller can use the
2609 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2610 on any messages that it does want to receive, if any.
2613 <column name="controller_rate_limit">
2615 The maximum rate at which the switch will forward packets to the
2616 OpenFlow controller, in packets per second. This feature prevents a
2617 single bridge from overwhelming the controller. If not specified,
2618 the default is implementation-specific.
2622 In addition, when a high rate triggers rate-limiting, Open vSwitch
2623 queues controller packets for each port and transmits them to the
2624 controller at the configured rate. The <ref
2625 column="controller_burst_limit"/> value limits the number of queued
2626 packets. Ports on a bridge share the packet queue fairly.
2630 Open vSwitch maintains two such packet rate-limiters per bridge: one
2631 for packets sent up to the controller because they do not correspond
2632 to any flow, and the other for packets sent up to the controller by
2633 request through flow actions. When both rate-limiters are filled with
2634 packets, the actual rate that packets are sent to the controller is
2635 up to twice the specified rate.
2639 <column name="controller_burst_limit">
2640 In conjunction with <ref column="controller_rate_limit"/>,
2641 the maximum number of unused packet credits that the bridge will
2642 allow to accumulate, in packets. If not specified, the default
2643 is implementation-specific.
2647 <group title="Additional In-Band Configuration">
2648 <p>These values are considered only in in-band control mode (see
2649 <ref column="connection_mode"/>).</p>
2651 <p>When multiple controllers are configured on a single bridge, there
2652 should be only one set of unique values in these columns. If different
2653 values are set for these columns in different controllers, the effect
2656 <column name="local_ip">
2657 The IP address to configure on the local port,
2658 e.g. <code>192.168.0.123</code>. If this value is unset, then
2659 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2663 <column name="local_netmask">
2664 The IP netmask to configure on the local port,
2665 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2666 but this value is unset, then the default is chosen based on whether
2667 the IP address is class A, B, or C.
2670 <column name="local_gateway">
2671 The IP address of the gateway to configure on the local port, as a
2672 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2673 this network has no gateway.
2677 <group title="Controller Status">
2678 <column name="is_connected">
2679 <code>true</code> if currently connected to this controller,
2680 <code>false</code> otherwise.
2684 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2685 <p>The level of authority this controller has on the associated
2686 bridge. Possible values are:</p>
2688 <dt><code>other</code></dt>
2689 <dd>Allows the controller access to all OpenFlow features.</dd>
2690 <dt><code>master</code></dt>
2691 <dd>Equivalent to <code>other</code>, except that there may be at
2692 most one master controller at a time. When a controller configures
2693 itself as <code>master</code>, any existing master is demoted to
2694 the <code>slave</code>role.</dd>
2695 <dt><code>slave</code></dt>
2696 <dd>Allows the controller read-only access to OpenFlow features.
2697 Attempts to modify the flow table will be rejected with an
2698 error. Slave controllers do not receive OFPT_PACKET_IN or
2699 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2704 <column name="status" key="last_error">
2705 A human-readable description of the last error on the connection
2706 to the controller; i.e. <code>strerror(errno)</code>. This key
2707 will exist only if an error has occurred.
2710 <column name="status" key="state"
2711 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2713 The state of the connection to the controller:
2716 <dt><code>VOID</code></dt>
2717 <dd>Connection is disabled.</dd>
2719 <dt><code>BACKOFF</code></dt>
2720 <dd>Attempting to reconnect at an increasing period.</dd>
2722 <dt><code>CONNECTING</code></dt>
2723 <dd>Attempting to connect.</dd>
2725 <dt><code>ACTIVE</code></dt>
2726 <dd>Connected, remote host responsive.</dd>
2728 <dt><code>IDLE</code></dt>
2729 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2732 These values may change in the future. They are provided only for
2737 <column name="status" key="sec_since_connect"
2738 type='{"type": "integer", "minInteger": 0}'>
2739 The amount of time since this controller last successfully connected to
2740 the switch (in seconds). Value is empty if controller has never
2741 successfully connected.
2744 <column name="status" key="sec_since_disconnect"
2745 type='{"type": "integer", "minInteger": 1}'>
2746 The amount of time since this controller last disconnected from
2747 the switch (in seconds). Value is empty if controller has never
2752 <group title="Connection Parameters">
2754 Additional configuration for a connection between the controller
2755 and the Open vSwitch.
2758 <column name="other_config" key="dscp"
2759 type='{"type": "integer"}'>
2760 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2761 in the Type of Service (TOS) field in the IP header. DSCP provides a
2762 mechanism to classify the network traffic and provide Quality of
2763 Service (QoS) on IP networks.
2765 The DSCP value specified here is used when establishing the connection
2766 between the controller and the Open vSwitch. If no value is specified,
2767 a default value of 48 is chosen. Valid DSCP values must be in the
2773 <group title="Common Columns">
2774 The overall purpose of these columns is described under <code>Common
2775 Columns</code> at the beginning of this document.
2777 <column name="external_ids"/>
2778 <column name="other_config"/>
2782 <table name="Manager" title="OVSDB management connection.">
2784 Configuration for a database connection to an Open vSwitch database
2789 This table primarily configures the Open vSwitch database
2790 (<code>ovsdb-server</code>), not the Open vSwitch switch
2791 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2792 what connections should be treated as in-band.
2796 The Open vSwitch database server can initiate and maintain active
2797 connections to remote clients. It can also listen for database
2801 <group title="Core Features">
2802 <column name="target">
2803 <p>Connection method for managers.</p>
2805 The following connection methods are currently supported:
2808 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2811 The specified SSL <var>port</var> (default: 6632) on the host at
2812 the given <var>ip</var>, which must be expressed as an IP address
2813 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2814 column in the <ref table="Open_vSwitch"/> table must point to a
2815 valid SSL configuration when this form is used.
2818 SSL support is an optional feature that is not always built as
2819 part of Open vSwitch.
2823 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2825 The specified TCP <var>port</var> (default: 6632) on the host at
2826 the given <var>ip</var>, which must be expressed as an IP address
2829 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2832 Listens for SSL 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 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2839 table="Open_vSwitch"/> table must point to a valid SSL
2840 configuration when this form is used.
2843 SSL support is an optional feature that is not always built as
2844 part of Open vSwitch.
2847 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2849 Listens for connections on the specified TCP <var>port</var>
2850 (default: 6632). If <var>ip</var>, which must be expressed as an
2851 IP address (not a DNS name), is specified, then connections are
2852 restricted to the specified local IP address.
2855 <p>When multiple managers are configured, the <ref column="target"/>
2856 values must be unique. Duplicate <ref column="target"/> values yield
2857 unspecified results.</p>
2860 <column name="connection_mode">
2862 If it is specified, this setting must be one of the following strings
2863 that describes how Open vSwitch contacts this OVSDB client over the
2868 <dt><code>in-band</code></dt>
2870 In this mode, this connection's traffic travels over a bridge
2871 managed by Open vSwitch. With this setting, Open vSwitch allows
2872 traffic to and from the client regardless of the contents of the
2873 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2874 to connect to the client, because it did not have a flow to enable
2875 it.) This is the most common connection mode because it is not
2876 necessary to maintain two independent networks.
2878 <dt><code>out-of-band</code></dt>
2880 In this mode, the client's traffic uses a control network separate
2881 from that managed by Open vSwitch, that is, Open vSwitch does not
2882 use any of its own network devices to communicate with the client.
2883 The control network must be configured separately, before or after
2884 <code>ovs-vswitchd</code> is started.
2889 If not specified, the default is implementation-specific.
2894 <group title="Client Failure Detection and Handling">
2895 <column name="max_backoff">
2896 Maximum number of milliseconds to wait between connection attempts.
2897 Default is implementation-specific.
2900 <column name="inactivity_probe">
2901 Maximum number of milliseconds of idle time on connection to the client
2902 before sending an inactivity probe message. If Open vSwitch does not
2903 communicate with the client for the specified number of seconds, it
2904 will send a probe. If a response is not received for the same
2905 additional amount of time, Open vSwitch assumes the connection has been
2906 broken and attempts to reconnect. Default is implementation-specific.
2907 A value of 0 disables inactivity probes.
2911 <group title="Status">
2912 <column name="is_connected">
2913 <code>true</code> if currently connected to this manager,
2914 <code>false</code> otherwise.
2917 <column name="status" key="last_error">
2918 A human-readable description of the last error on the connection
2919 to the manager; i.e. <code>strerror(errno)</code>. This key
2920 will exist only if an error has occurred.
2923 <column name="status" key="state"
2924 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2926 The state of the connection to the manager:
2929 <dt><code>VOID</code></dt>
2930 <dd>Connection is disabled.</dd>
2932 <dt><code>BACKOFF</code></dt>
2933 <dd>Attempting to reconnect at an increasing period.</dd>
2935 <dt><code>CONNECTING</code></dt>
2936 <dd>Attempting to connect.</dd>
2938 <dt><code>ACTIVE</code></dt>
2939 <dd>Connected, remote host responsive.</dd>
2941 <dt><code>IDLE</code></dt>
2942 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2945 These values may change in the future. They are provided only for
2950 <column name="status" key="sec_since_connect"
2951 type='{"type": "integer", "minInteger": 0}'>
2952 The amount of time since this manager last successfully connected
2953 to the database (in seconds). Value is empty if manager has never
2954 successfully connected.
2957 <column name="status" key="sec_since_disconnect"
2958 type='{"type": "integer", "minInteger": 0}'>
2959 The amount of time since this manager last disconnected from the
2960 database (in seconds). Value is empty if manager has never
2964 <column name="status" key="locks_held">
2965 Space-separated list of the names of OVSDB locks that the connection
2966 holds. Omitted if the connection does not hold any locks.
2969 <column name="status" key="locks_waiting">
2970 Space-separated list of the names of OVSDB locks that the connection is
2971 currently waiting to acquire. Omitted if the connection is not waiting
2975 <column name="status" key="locks_lost">
2976 Space-separated list of the names of OVSDB locks that the connection
2977 has had stolen by another OVSDB client. Omitted if no locks have been
2978 stolen from this connection.
2981 <column name="status" key="n_connections"
2982 type='{"type": "integer", "minInteger": 2}'>
2984 When <ref column="target"/> specifies a connection method that
2985 listens for inbound connections (e.g. <code>ptcp:</code> or
2986 <code>pssl:</code>) and more than one connection is actually active,
2987 the value is the number of active connections. Otherwise, this
2988 key-value pair is omitted.
2991 When multiple connections are active, status columns and key-value
2992 pairs (other than this one) report the status of one arbitrarily
2998 <group title="Connection Parameters">
3000 Additional configuration for a connection between the manager
3001 and the Open vSwitch Database.
3004 <column name="other_config" key="dscp"
3005 type='{"type": "integer"}'>
3006 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3007 in the Type of Service (TOS) field in the IP header. DSCP provides a
3008 mechanism to classify the network traffic and provide Quality of
3009 Service (QoS) on IP networks.
3011 The DSCP value specified here is used when establishing the connection
3012 between the manager and the Open vSwitch. If no value is specified, a
3013 default value of 48 is chosen. Valid DSCP values must be in the range
3018 <group title="Common Columns">
3019 The overall purpose of these columns is described under <code>Common
3020 Columns</code> at the beginning of this document.
3022 <column name="external_ids"/>
3023 <column name="other_config"/>
3027 <table name="NetFlow">
3028 A NetFlow target. NetFlow is a protocol that exports a number of
3029 details about terminating IP flows, such as the principals involved
3032 <column name="targets">
3033 NetFlow targets in the form
3034 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3035 must be specified numerically, not as a DNS name.
3038 <column name="engine_id">
3039 Engine ID to use in NetFlow messages. Defaults to datapath index
3043 <column name="engine_type">
3044 Engine type to use in NetFlow messages. Defaults to datapath
3045 index if not specified.
3048 <column name="active_timeout">
3049 The interval at which NetFlow records are sent for flows that are
3050 still active, in seconds. A value of <code>0</code> requests the
3051 default timeout (currently 600 seconds); a value of <code>-1</code>
3052 disables active timeouts.
3055 <column name="add_id_to_interface">
3056 <p>If this column's value is <code>false</code>, the ingress and egress
3057 interface fields of NetFlow flow records are derived from OpenFlow port
3058 numbers. When it is <code>true</code>, the 7 most significant bits of
3059 these fields will be replaced by the least significant 7 bits of the
3060 engine id. This is useful because many NetFlow collectors do not
3061 expect multiple switches to be sending messages from the same host, so
3062 they do not store the engine information which could be used to
3063 disambiguate the traffic.</p>
3064 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3067 <group title="Common Columns">
3068 The overall purpose of these columns is described under <code>Common
3069 Columns</code> at the beginning of this document.
3071 <column name="external_ids"/>
3076 SSL configuration for an Open_vSwitch.
3078 <column name="private_key">
3079 Name of a PEM file containing the private key used as the switch's
3080 identity for SSL connections to the controller.
3083 <column name="certificate">
3084 Name of a PEM file containing a certificate, signed by the
3085 certificate authority (CA) used by the controller and manager,
3086 that certifies the switch's private key, identifying a trustworthy
3090 <column name="ca_cert">
3091 Name of a PEM file containing the CA certificate used to verify
3092 that the switch is connected to a trustworthy controller.
3095 <column name="bootstrap_ca_cert">
3096 If set to <code>true</code>, then Open vSwitch will attempt to
3097 obtain the CA certificate from the controller on its first SSL
3098 connection and save it to the named PEM file. If it is successful,
3099 it will immediately drop the connection and reconnect, and from then
3100 on all SSL connections must be authenticated by a certificate signed
3101 by the CA certificate thus obtained. <em>This option exposes the
3102 SSL connection to a man-in-the-middle attack obtaining the initial
3103 CA certificate.</em> It may still be useful for bootstrapping.
3106 <group title="Common Columns">
3107 The overall purpose of these columns is described under <code>Common
3108 Columns</code> at the beginning of this document.
3110 <column name="external_ids"/>
3114 <table name="sFlow">
3115 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3118 <column name="agent">
3119 Name of the network device whose IP address should be reported as the
3120 ``agent address'' to collectors. If not specified, the agent device is
3121 figured from the first target address and the routing table. If the
3122 routing table does not contain a route to the target, the IP address
3123 defaults to the <ref table="Controller" column="local_ip"/> in the
3124 collector's <ref table="Controller"/>. If an agent IP address cannot be
3125 determined any of these ways, sFlow is disabled.
3128 <column name="header">
3129 Number of bytes of a sampled packet to send to the collector.
3130 If not specified, the default is 128 bytes.
3133 <column name="polling">
3134 Polling rate in seconds to send port statistics to the collector.
3135 If not specified, defaults to 30 seconds.
3138 <column name="sampling">
3139 Rate at which packets should be sampled and sent to the collector.
3140 If not specified, defaults to 400, which means one out of 400
3141 packets, on average, will be sent to the collector.
3144 <column name="targets">
3145 sFlow targets in the form
3146 <code><var>ip</var>:<var>port</var></code>.
3149 <group title="Common Columns">
3150 The overall purpose of these columns is described under <code>Common
3151 Columns</code> at the beginning of this document.
3153 <column name="external_ids"/>