1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="disable-in-band"
443 type='{"type": "boolean"}'>
444 If set to <code>true</code>, disable in-band control on the bridge
445 regardless of controller and manager settings.
448 <column name="other_config" key="in-band-queue"
449 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
450 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
451 that will be used by flows set up by in-band control on this bridge.
452 If unset, or if the port used by an in-band control flow does not have
453 QoS configured, or if the port does not have a queue with the specified
454 ID, the default queue is used instead.
458 <group title="Spanning Tree Configuration">
459 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
460 that ensures loop-free topologies. It allows redundant links to
461 be included in the network to provide automatic backup paths if
462 the active links fails.
464 <column name="stp_enable">
465 Enable spanning tree on the bridge. By default, STP is disabled
466 on bridges. Bond, internal, and mirror ports are not supported
467 and will not participate in the spanning tree.
470 <column name="other_config" key="stp-system-id">
471 The bridge's STP identifier (the lower 48 bits of the bridge-id)
473 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
474 By default, the identifier is the MAC address of the bridge.
477 <column name="other_config" key="stp-priority"
478 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
479 The bridge's relative priority value for determining the root
480 bridge (the upper 16 bits of the bridge-id). A bridge with the
481 lowest bridge-id is elected the root. By default, the priority
485 <column name="other_config" key="stp-hello-time"
486 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
487 The interval between transmissions of hello messages by
488 designated ports, in seconds. By default the hello interval is
492 <column name="other_config" key="stp-max-age"
493 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
494 The maximum age of the information transmitted by the bridge
495 when it is the root bridge, in seconds. By default, the maximum
499 <column name="other_config" key="stp-forward-delay"
500 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
501 The delay to wait between transitioning root and designated
502 ports to <code>forwarding</code>, in seconds. By default, the
503 forwarding delay is 15 seconds.
507 <group title="Other Features">
508 <column name="datapath_type">
509 Name of datapath provider. The kernel datapath has
510 type <code>system</code>. The userspace datapath has
511 type <code>netdev</code>.
514 <column name="external_ids" key="bridge-id">
515 A unique identifier of the bridge. On Citrix XenServer this will
516 commonly be the same as
517 <ref column="external_ids" key="xs-network-uuids"/>.
520 <column name="external_ids" key="xs-network-uuids">
521 Semicolon-delimited set of universally unique identifier(s) for the
522 network with which this bridge is associated on a Citrix XenServer
523 host. The network identifiers are RFC 4122 UUIDs as displayed by,
524 e.g., <code>xe network-list</code>.
527 <column name="other_config" key="hwaddr">
528 An Ethernet address in the form
529 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
530 to set the hardware address of the local port and influence the
534 <column name="other_config" key="flow-eviction-threshold"
535 type='{"type": "integer", "minInteger": 0}'>
537 A number of flows as a nonnegative integer. This sets number of
538 flows at which eviction from the kernel flow table will be triggered.
539 If there are a large number of flows then increasing this value to
540 around the number of flows present can result in reduced CPU usage
544 The default is 1000. Values below 100 will be rounded up to 100.
548 <column name="other_config" key="forward-bpdu"
549 type='{"type": "boolean"}'>
550 Option to allow forwarding of BPDU frames when NORMAL action is
551 invoked. Frames with reserved Ethernet addresses (e.g. STP
552 BPDU) will be forwarded when this option is enabled and the
553 switch is not providing that functionality. If STP is enabled
554 on the port, STP BPDUs will never be forwarded. If the Open
555 vSwitch bridge is used to connect different Ethernet networks,
556 and if Open vSwitch node does not run STP, then this option
557 should be enabled. Default is disabled, set to
558 <code>true</code> to enable.
561 <column name="other_config" key="mac-aging-time"
562 type='{"type": "integer", "minInteger": 1}'>
564 The maximum number of seconds to retain a MAC learning entry for
565 which no packets have been seen. The default is currently 300
566 seconds (5 minutes). The value, if specified, is forced into a
567 reasonable range, currently 15 to 3600 seconds.
571 A short MAC aging time allows a network to more quickly detect that a
572 host is no longer connected to a switch port. However, it also makes
573 it more likely that packets will be flooded unnecessarily, when they
574 are addressed to a connected host that rarely transmits packets. To
575 reduce the incidence of unnecessary flooding, use a MAC aging time
576 longer than the maximum interval at which a host will ordinarily
582 <group title="Bridge Status">
584 Status information about bridges.
586 <column name="status">
587 Key-value pairs that report bridge status.
589 <column name="status" key="stp_bridge_id">
591 The bridge-id (in hex) used in spanning tree advertisements.
592 Configuring the bridge-id is described in the
593 <code>stp-system-id</code> and <code>stp-priority</code> keys
594 of the <code>other_config</code> section earlier.
597 <column name="status" key="stp_designated_root">
599 The designated root (in hex) for this spanning tree.
602 <column name="status" key="stp_root_path_cost">
604 The path cost of reaching the designated bridge. A lower
610 <group title="Common Columns">
611 The overall purpose of these columns is described under <code>Common
612 Columns</code> at the beginning of this document.
614 <column name="other_config"/>
615 <column name="external_ids"/>
619 <table name="Port" table="Port or bond configuration.">
620 <p>A port within a <ref table="Bridge"/>.</p>
621 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
622 <ref column="interfaces"/> column. Such a port logically
623 corresponds to a port on a physical Ethernet switch. A port
624 with more than one interface is a ``bonded port'' (see
625 <ref group="Bonding Configuration"/>).</p>
626 <p>Some properties that one might think as belonging to a port are actually
627 part of the port's <ref table="Interface"/> members.</p>
630 Port name. Should be alphanumeric and no more than about 8
631 bytes long. May be the same as the interface name, for
632 non-bonded ports. Must otherwise be unique among the names of
633 ports, interfaces, and bridges on a host.
636 <column name="interfaces">
637 The port's interfaces. If there is more than one, this is a
641 <group title="VLAN Configuration">
642 <p>Bridge ports support the following types of VLAN configuration:</p>
647 A trunk port carries packets on one or more specified VLANs
648 specified in the <ref column="trunks"/> column (often, on every
649 VLAN). A packet that ingresses on a trunk port is in the VLAN
650 specified in its 802.1Q header, or VLAN 0 if the packet has no
651 802.1Q header. A packet that egresses through a trunk port will
652 have an 802.1Q header if it has a nonzero VLAN ID.
656 Any packet that ingresses on a trunk port tagged with a VLAN that
657 the port does not trunk is dropped.
664 An access port carries packets on exactly one VLAN specified in the
665 <ref column="tag"/> column. Packets egressing on an access port
666 have no 802.1Q header.
670 Any packet with an 802.1Q header with a nonzero VLAN ID that
671 ingresses on an access port is dropped, regardless of whether the
672 VLAN ID in the header is the access port's VLAN ID.
676 <dt>native-tagged</dt>
678 A native-tagged port resembles a trunk port, with the exception that
679 a packet without an 802.1Q header that ingresses on a native-tagged
680 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
684 <dt>native-untagged</dt>
686 A native-untagged port resembles a native-tagged port, with the
687 exception that a packet that egresses on a native-untagged port in
688 the native VLAN will not have an 802.1Q header.
692 A packet will only egress through bridge ports that carry the VLAN of
693 the packet, as described by the rules above.
696 <column name="vlan_mode">
698 The VLAN mode of the port, as described above. When this column is
699 empty, a default mode is selected as follows:
703 If <ref column="tag"/> contains a value, the port is an access
704 port. The <ref column="trunks"/> column should be empty.
707 Otherwise, the port is a trunk port. The <ref column="trunks"/>
708 column value is honored if it is present.
715 For an access port, the port's implicitly tagged VLAN. For a
716 native-tagged or native-untagged port, the port's native VLAN. Must
717 be empty if this is a trunk port.
721 <column name="trunks">
723 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
724 or VLANs that this port trunks; if it is empty, then the port trunks
725 all VLANs. Must be empty if this is an access port.
728 A native-tagged or native-untagged port always trunks its native
729 VLAN, regardless of whether <ref column="trunks"/> includes that
734 <column name="other_config" key="priority-tags"
735 type='{"type": "boolean"}'>
737 An 802.1Q header contains two important pieces of information: a VLAN
738 ID and a priority. A frame with a zero VLAN ID, called a
739 ``priority-tagged'' frame, is supposed to be treated the same way as
740 a frame without an 802.1Q header at all (except for the priority).
744 However, some network elements ignore any frame that has 802.1Q
745 header at all, even when the VLAN ID is zero. Therefore, by default
746 Open vSwitch does not output priority-tagged frames, instead omitting
747 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
748 <code>true</code> to enable priority-tagged frames on a port.
752 Regardless of this setting, Open vSwitch omits the 802.1Q header on
753 output if both the VLAN ID and priority would be zero.
757 All frames output to native-tagged ports have a nonzero VLAN ID, so
758 this setting is not meaningful on native-tagged ports.
763 <group title="Bonding Configuration">
764 <p>A port that has more than one interface is a ``bonded port.'' Bonding
765 allows for load balancing and fail-over. Some kinds of bonding will
766 work with any kind of upstream switch:</p>
769 <dt><code>balance-slb</code></dt>
771 Balances flows among slaves based on source MAC address and output
772 VLAN, with periodic rebalancing as traffic patterns change.
775 <dt><code>active-backup</code></dt>
777 Assigns all flows to one slave, failing over to a backup slave when
778 the active slave is disabled.
783 The following modes require the upstream switch to support 802.3ad with
784 successful LACP negotiation:
788 <dt><code>balance-tcp</code></dt>
790 Balances flows among slaves based on L2, L3, and L4 protocol
791 information such as destination MAC address, IP address, and TCP
795 <dt><code>stable</code></dt>
797 <p>Attempts to always assign a given flow to the same slave
798 consistently. In an effort to maintain stability, no load
799 balancing is done. Uses a similar hashing strategy to
800 <code>balance-tcp</code>, always taking into account L3 and L4
801 fields even if LACP negotiations are unsuccessful. </p>
802 <p>Slave selection decisions are made based on <ref table="Interface"
803 column="other_config" key="bond-stable-id"/> if set. Otherwise,
804 OpenFlow port number is used. Decisions are consistent across all
805 <code>ovs-vswitchd</code> instances with equivalent
806 <ref table="Interface" column="other_config" key="bond-stable-id"/>
811 <p>These columns apply only to bonded ports. Their values are
812 otherwise ignored.</p>
814 <column name="bond_mode">
815 <p>The type of bonding used for a bonded port. Defaults to
816 <code>active-backup</code> if unset.
820 <column name="other_config" key="bond-hash-basis"
821 type='{"type": "integer"}'>
822 An integer hashed along with flows when choosing output slaves in load
823 balanced bonds. When changed, all flows will be assigned different
824 hash values possibly causing slave selection decisions to change. Does
825 not affect bonding modes which do not employ load balancing such as
826 <code>active-backup</code>.
829 <group title="Link Failure Detection">
831 An important part of link bonding is detecting that links are down so
832 that they may be disabled. These settings determine how Open vSwitch
833 detects link failure.
836 <column name="other_config" key="bond-detect-mode"
837 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
838 The means used to detect link failures. Defaults to
839 <code>carrier</code> which uses each interface's carrier to detect
840 failures. When set to <code>miimon</code>, will check for failures
841 by polling each interface's MII.
844 <column name="other_config" key="bond-miimon-interval"
845 type='{"type": "integer"}'>
846 The interval, in milliseconds, between successive attempts to poll
847 each interface's MII. Relevant only when <ref column="other_config"
848 key="bond-detect-mode"/> is <code>miimon</code>.
851 <column name="bond_updelay">
853 The number of milliseconds for which carrier must stay up on an
854 interface before the interface is considered to be up. Specify
855 <code>0</code> to enable the interface immediately.
859 This setting is honored only when at least one bonded interface is
860 already enabled. When no interfaces are enabled, then the first
861 bond interface to come up is enabled immediately.
865 <column name="bond_downdelay">
866 The number of milliseconds for which carrier must stay down on an
867 interface before the interface is considered to be down. Specify
868 <code>0</code> to disable the interface immediately.
872 <group title="LACP Configuration">
874 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
875 allows switches to automatically detect that they are connected by
876 multiple links and aggregate across those links. These settings
877 control LACP behavior.
881 Configures LACP on this port. LACP allows directly connected
882 switches to negotiate which links may be bonded. LACP may be enabled
883 on non-bonded ports for the benefit of any switches they may be
884 connected to. <code>active</code> ports are allowed to initiate LACP
885 negotiations. <code>passive</code> ports are allowed to participate
886 in LACP negotiations initiated by a remote switch, but not allowed to
887 initiate such negotiations themselves. If LACP is enabled on a port
888 whose partner switch does not support LACP, the bond will be
889 disabled. Defaults to <code>off</code> if unset.
892 <column name="other_config" key="lacp-system-id">
893 The LACP system ID of this <ref table="Port"/>. The system ID of a
894 LACP bond is used to identify itself to its partners. Must be a
895 nonzero MAC address. Defaults to the bridge Ethernet address if
899 <column name="other_config" key="lacp-system-priority"
900 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
901 The LACP system priority of this <ref table="Port"/>. In LACP
902 negotiations, link status decisions are made by the system with the
903 numerically lower priority.
906 <column name="other_config" key="lacp-time"
907 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
909 The LACP timing which should be used on this <ref table="Port"/>.
910 By default <code>slow</code> is used. When configured to be
911 <code>fast</code> LACP heartbeats are requested at a rate of once
912 per second causing connectivity problems to be detected more
913 quickly. In <code>slow</code> mode, heartbeats are requested at a
914 rate of once every 30 seconds.
919 <group title="SLB Configuration">
921 These settings control behavior when a bond is in
922 <code>balance-slb</code> mode, regardless of whether the bond was
923 intentionally configured in SLB mode or it fell back to SLB mode
924 because LACP negotiation failed.
927 <column name="other_config" key="bond-rebalance-interval"
928 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
929 For a load balanced bonded port, the number of milliseconds between
930 successive attempts to rebalance the bond, that is, to move flows
931 from one interface on the bond to another in an attempt to keep usage
932 of each interface roughly equal. If zero, load balancing is disabled
933 on the bond (carrier status changes still cause flows to move). If
934 less than 1000ms, the rebalance interval will be 1000ms.
938 <column name="bond_fake_iface">
939 For a bonded port, whether to create a fake internal interface with the
940 name of the port. Use only for compatibility with legacy software that
945 <group title="Spanning Tree Configuration">
946 <column name="other_config" key="stp-enable"
947 type='{"type": "boolean"}'>
948 If spanning tree is enabled on the bridge, member ports are
949 enabled by default (with the exception of bond, internal, and
950 mirror ports which do not work with STP). If this column's
951 value is <code>false</code> spanning tree is disabled on the
955 <column name="other_config" key="stp-port-num"
956 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
957 The port number used for the lower 8 bits of the port-id. By
958 default, the numbers will be assigned automatically. If any
959 port's number is manually configured on a bridge, then they
963 <column name="other_config" key="stp-port-priority"
964 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
965 The port's relative priority value for determining the root
966 port (the upper 8 bits of the port-id). A port with a lower
967 port-id will be chosen as the root port. By default, the
971 <column name="other_config" key="stp-path-cost"
972 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
973 Spanning tree path cost for the port. A lower number indicates
974 a faster link. By default, the cost is based on the maximum
979 <group title="Other Features">
981 Quality of Service configuration for this port.
985 The MAC address to use for this port for the purpose of choosing the
986 bridge's MAC address. This column does not necessarily reflect the
987 port's actual MAC address, nor will setting it change the port's actual
991 <column name="fake_bridge">
992 Does this port represent a sub-bridge for its tagged VLAN within the
993 Bridge? See ovs-vsctl(8) for more information.
996 <column name="external_ids" key="fake-bridge-id-*">
997 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
998 column) are defined by prefixing a <ref table="Bridge"/> <ref
999 table="Bridge" column="external_ids"/> key with
1000 <code>fake-bridge-</code>,
1001 e.g. <code>fake-bridge-xs-network-uuids</code>.
1005 <group title="Port Status">
1007 Status information about ports attached to bridges.
1009 <column name="status">
1010 Key-value pairs that report port status.
1012 <column name="status" key="stp_port_id">
1014 The port-id (in hex) used in spanning tree advertisements for
1015 this port. Configuring the port-id is described in the
1016 <code>stp-port-num</code> and <code>stp-port-priority</code>
1017 keys of the <code>other_config</code> section earlier.
1020 <column name="status" key="stp_state"
1021 type='{"type": "string", "enum": ["set",
1022 ["disabled", "listening", "learning",
1023 "forwarding", "blocking"]]}'>
1025 STP state of the port.
1028 <column name="status" key="stp_sec_in_state"
1029 type='{"type": "integer", "minInteger": 0}'>
1031 The amount of time (in seconds) port has been in the current
1035 <column name="status" key="stp_role"
1036 type='{"type": "string", "enum": ["set",
1037 ["root", "designated", "alternate"]]}'>
1039 STP role of the port.
1044 <group title="Port Statistics">
1046 Key-value pairs that report port statistics.
1048 <group title="Statistics: STP transmit and receive counters">
1049 <column name="statistics" key="stp_tx_count">
1050 Number of STP BPDUs sent on this port by the spanning
1053 <column name="statistics" key="stp_rx_count">
1054 Number of STP BPDUs received on this port and accepted by the
1055 spanning tree library.
1057 <column name="statistics" key="stp_error_count">
1058 Number of bad STP BPDUs received on this port. Bad BPDUs
1059 include runt packets and those with an unexpected protocol ID.
1064 <group title="Common Columns">
1065 The overall purpose of these columns is described under <code>Common
1066 Columns</code> at the beginning of this document.
1068 <column name="other_config"/>
1069 <column name="external_ids"/>
1073 <table name="Interface" title="One physical network device in a Port.">
1074 An interface within a <ref table="Port"/>.
1076 <group title="Core Features">
1077 <column name="name">
1078 Interface name. Should be alphanumeric and no more than about 8 bytes
1079 long. May be the same as the port name, for non-bonded ports. Must
1080 otherwise be unique among the names of ports, interfaces, and bridges
1085 <p>Ethernet address to set for this interface. If unset then the
1086 default MAC address is used:</p>
1088 <li>For the local interface, the default is the lowest-numbered MAC
1089 address among the other bridge ports, either the value of the
1090 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1091 if set, or its actual MAC (for bonded ports, the MAC of its slave
1092 whose name is first in alphabetical order). Internal ports and
1093 bridge ports that are used as port mirroring destinations (see the
1094 <ref table="Mirror"/> table) are ignored.</li>
1095 <li>For other internal interfaces, the default MAC is randomly
1097 <li>External interfaces typically have a MAC address associated with
1098 their hardware.</li>
1100 <p>Some interfaces may not have a software-controllable MAC
1104 <column name="ofport">
1105 <p>OpenFlow port number for this interface. Unlike most columns, this
1106 column's value should be set only by Open vSwitch itself. Other
1107 clients should set this column to an empty set (the default) when
1108 creating an <ref table="Interface"/>.</p>
1109 <p>Open vSwitch populates this column when the port number becomes
1110 known. If the interface is successfully added,
1111 <ref column="ofport"/> will be set to a number between 1 and 65535
1112 (generally either in the range 1 to 65279, inclusive, or 65534, the
1113 port number for the OpenFlow ``local port''). If the interface
1114 cannot be added then Open vSwitch sets this column
1119 <group title="System-Specific Details">
1120 <column name="type">
1122 The interface type, one of:
1126 <dt><code>system</code></dt>
1127 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1128 Sometimes referred to as ``external interfaces'' since they are
1129 generally connected to hardware external to that on which the Open
1130 vSwitch is running. The empty string is a synonym for
1131 <code>system</code>.</dd>
1133 <dt><code>internal</code></dt>
1134 <dd>A simulated network device that sends and receives traffic. An
1135 internal interface whose <ref column="name"/> is the same as its
1136 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1137 ``local interface.'' It does not make sense to bond an internal
1138 interface, so the terms ``port'' and ``interface'' are often used
1139 imprecisely for internal interfaces.</dd>
1141 <dt><code>tap</code></dt>
1142 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1144 <dt><code>gre</code></dt>
1146 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1147 tunnel. See <ref group="Tunnel Options"/> for information on
1148 configuring GRE tunnels.
1151 <dt><code>ipsec_gre</code></dt>
1153 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1157 <dt><code>capwap</code></dt>
1159 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1160 5415). This allows interoperability with certain switches that do
1161 not support GRE. Only the tunneling component of the protocol is
1162 implemented. UDP ports 58881 and 58882 are used as the source and
1163 destination ports respectively. CAPWAP is currently supported only
1164 with the Linux kernel datapath with kernel version 2.6.26 or later.
1167 <dt><code>patch</code></dt>
1169 A pair of virtual devices that act as a patch cable.
1172 <dt><code>null</code></dt>
1173 <dd>An ignored interface.</dd>
1178 <group title="Tunnel Options">
1180 These options apply to interfaces with <ref column="type"/> of
1181 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1185 Each tunnel must be uniquely identified by the combination of <ref
1186 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1187 column="options" key="local_ip"/>, and <ref column="options"
1188 key="in_key"/>. If two ports are defined that are the same except one
1189 has an optional identifier and the other does not, the more specific
1190 one is matched first. <ref column="options" key="in_key"/> is
1191 considered more specific than <ref column="options" key="local_ip"/> if
1192 a port defines one and another port defines the other.
1195 <column name="options" key="remote_ip">
1197 Required. The tunnel endpoint. Unicast and multicast endpoints are
1202 When a multicast endpoint is specified, a routing table lookup occurs
1203 only when the tunnel is created. Following a routing change, delete
1204 and then re-create the tunnel to force a new routing table lookup.
1208 <column name="options" key="local_ip">
1209 Optional. The destination IP that received packets must match.
1210 Default is to match all addresses. Must be omitted when <ref
1211 column="options" key="remote_ip"/> is a multicast address.
1214 <column name="options" key="in_key">
1215 <p>Optional. The key that received packets must contain, one of:</p>
1219 <code>0</code>. The tunnel receives packets with no key or with a
1220 key of 0. This is equivalent to specifying no <ref column="options"
1221 key="in_key"/> at all.
1224 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1225 tunnel receives only packets with the specified key.
1228 The word <code>flow</code>. The tunnel accepts packets with any
1229 key. The key will be placed in the <code>tun_id</code> field for
1230 matching in the flow table. The <code>ovs-ofctl</code> manual page
1231 contains additional information about matching fields in OpenFlow
1240 <column name="options" key="out_key">
1241 <p>Optional. The key to be set on outgoing packets, one of:</p>
1245 <code>0</code>. Packets sent through the tunnel will have no key.
1246 This is equivalent to specifying no <ref column="options"
1247 key="out_key"/> at all.
1250 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1251 sent through the tunnel will have the specified key.
1254 The word <code>flow</code>. Packets sent through the tunnel will
1255 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1256 vendor extension (0 is used in the absence of an action). The
1257 <code>ovs-ofctl</code> manual page contains additional information
1258 about the Nicira OpenFlow vendor extensions.
1263 <column name="options" key="key">
1264 Optional. Shorthand to set <code>in_key</code> and
1265 <code>out_key</code> at the same time.
1268 <column name="options" key="tos">
1269 Optional. The value of the ToS bits to be set on the encapsulating
1270 packet. It may also be the word <code>inherit</code>, in which case
1271 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1272 (otherwise it will be 0). The ECN fields are always inherited.
1276 <column name="options" key="ttl">
1277 Optional. The TTL to be set on the encapsulating packet. It may also
1278 be the word <code>inherit</code>, in which case the TTL will be copied
1279 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1280 system default, typically 64). Default is the system default TTL.
1283 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1284 Optional. If enabled, the Don't Fragment bit will be copied from the
1285 inner IP headers (those of the encapsulated traffic) to the outer
1286 (tunnel) headers. Default is disabled; set to <code>true</code> to
1290 <column name="options" key="df_default"
1291 type='{"type": "boolean"}'>
1292 Optional. If enabled, the Don't Fragment bit will be set by default on
1293 tunnel headers if the <code>df_inherit</code> option is not set, or if
1294 the encapsulated packet is not IP. Default is enabled; set to
1295 <code>false</code> to disable.
1298 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1299 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1300 Destination Unreachable - Fragmentation Needed'' messages will be
1301 generated for IPv4 packets with the DF bit set and IPv6 packets above
1302 the minimum MTU if the packet size exceeds the path MTU minus the size
1303 of the tunnel headers. Note that this option causes behavior that is
1304 typically reserved for routers and therefore is not entirely in
1305 compliance with the IEEE 802.1D specification for bridges. Default is
1306 enabled; set to <code>false</code> to disable.
1309 <group title="Tunnel Options: gre only">
1311 Only <code>gre</code> interfaces support these options.
1314 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1315 Enable caching of tunnel headers and the output path. This can lead
1316 to a significant performance increase without changing behavior. In
1317 general it should not be necessary to adjust this setting. However,
1318 the caching can bypass certain components of the IP stack (such as
1319 <code>iptables</code>) and it may be useful to disable it if these
1320 features are required or as a debugging measure. Default is enabled,
1321 set to <code>false</code> to disable.
1325 <group title="Tunnel Options: gre and ipsec_gre only">
1327 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1331 <column name="options" key="csum" type='{"type": "boolean"}'>
1333 Optional. Compute GRE checksums on outgoing packets. Default is
1334 disabled, set to <code>true</code> to enable. Checksums present on
1335 incoming packets will be validated regardless of this setting.
1339 GRE checksums impose a significant performance penalty because they
1340 cover the entire packet. The encapsulated L3, L4, and L7 packet
1341 contents typically have their own checksums, so this additional
1342 checksum only adds value for the GRE and encapsulated L2 headers.
1346 This option is supported for <code>ipsec_gre</code>, but not useful
1347 because GRE checksums are weaker than, and redundant with, IPsec
1348 payload authentication.
1353 <group title="Tunnel Options: ipsec_gre only">
1355 Only <code>ipsec_gre</code> interfaces support these options.
1358 <column name="options" key="peer_cert">
1359 Required for certificate authentication. A string containing the
1360 peer's certificate in PEM format. Additionally the host's
1361 certificate must be specified with the <code>certificate</code>
1365 <column name="options" key="certificate">
1366 Required for certificate authentication. The name of a PEM file
1367 containing a certificate that will be presented to the peer during
1371 <column name="options" key="private_key">
1372 Optional for certificate authentication. The name of a PEM file
1373 containing the private key associated with <code>certificate</code>.
1374 If <code>certificate</code> contains the private key, this option may
1378 <column name="options" key="psk">
1379 Required for pre-shared key authentication. Specifies a pre-shared
1380 key for authentication that must be identical on both sides of the
1386 <group title="Patch Options">
1388 Only <code>patch</code> interfaces support these options.
1391 <column name="options" key="peer">
1392 The <ref column="name"/> of the <ref table="Interface"/> for the other
1393 side of the patch. The named <ref table="Interface"/>'s own
1394 <code>peer</code> option must specify this <ref table="Interface"/>'s
1395 name. That is, the two patch interfaces must have reversed <ref
1396 column="name"/> and <code>peer</code> values.
1400 <group title="Interface Status">
1402 Status information about interfaces attached to bridges, updated every
1403 5 seconds. Not all interfaces have all of these properties; virtual
1404 interfaces don't have a link speed, for example. Non-applicable
1405 columns will have empty values.
1407 <column name="admin_state">
1409 The administrative state of the physical network link.
1413 <column name="link_state">
1415 The observed state of the physical network link. This is ordinarily
1416 the link's carrier status. If the interface's <ref table="Port"/> is
1417 a bond configured for miimon monitoring, it is instead the network
1418 link's miimon status.
1422 <column name="link_resets">
1424 The number of times Open vSwitch has observed the
1425 <ref column="link_state"/> of this <ref table="Interface"/> change.
1429 <column name="link_speed">
1431 The negotiated speed of the physical network link.
1432 Valid values are positive integers greater than 0.
1436 <column name="duplex">
1438 The duplex mode of the physical network link.
1444 The MTU (maximum transmission unit); i.e. the largest
1445 amount of data that can fit into a single Ethernet frame.
1446 The standard Ethernet MTU is 1500 bytes. Some physical media
1447 and many kinds of virtual interfaces can be configured with
1451 This column will be empty for an interface that does not
1452 have an MTU as, for example, some kinds of tunnels do not.
1456 <column name="lacp_current">
1457 Boolean value indicating LACP status for this interface. If true, this
1458 interface has current LACP information about its LACP partner. This
1459 information may be used to monitor the health of interfaces in a LACP
1460 enabled port. This column will be empty if LACP is not enabled.
1463 <column name="status">
1464 Key-value pairs that report port status. Supported status values are
1465 <ref column="type"/>-dependent; some interfaces may not have a valid
1466 <ref column="status" key="driver_name"/>, for example.
1469 <column name="status" key="driver_name">
1470 The name of the device driver controlling the network adapter.
1473 <column name="status" key="driver_version">
1474 The version string of the device driver controlling the network
1478 <column name="status" key="firmware_version">
1479 The version string of the network adapter's firmware, if available.
1482 <column name="status" key="source_ip">
1483 The source IP address used for an IPv4 tunnel end-point, such as
1484 <code>gre</code> or <code>capwap</code>.
1487 <column name="status" key="tunnel_egress_iface">
1488 Egress interface for tunnels. Currently only relevant for GRE and
1489 CAPWAP tunnels. On Linux systems, this column will show the name of
1490 the interface which is responsible for routing traffic destined for the
1491 configured <ref column="options" key="remote_ip"/>. This could be an
1492 internal interface such as a bridge port.
1495 <column name="status" key="tunnel_egress_iface_carrier"
1496 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1497 Whether carrier is detected on <ref column="status"
1498 key="tunnel_egress_iface"/>.
1502 <group title="Statistics">
1504 Key-value pairs that report interface statistics. The current
1505 implementation updates these counters periodically. Future
1506 implementations may update them when an interface is created, when they
1507 are queried (e.g. using an OVSDB <code>select</code> operation), and
1508 just before an interface is deleted due to virtual interface hot-unplug
1509 or VM shutdown, and perhaps at other times, but not on any regular
1513 These are the same statistics reported by OpenFlow in its <code>struct
1514 ofp_port_stats</code> structure. If an interface does not support a
1515 given statistic, then that pair is omitted.
1517 <group title="Statistics: Successful transmit and receive counters">
1518 <column name="statistics" key="rx_packets">
1519 Number of received packets.
1521 <column name="statistics" key="rx_bytes">
1522 Number of received bytes.
1524 <column name="statistics" key="tx_packets">
1525 Number of transmitted packets.
1527 <column name="statistics" key="tx_bytes">
1528 Number of transmitted bytes.
1531 <group title="Statistics: Receive errors">
1532 <column name="statistics" key="rx_dropped">
1533 Number of packets dropped by RX.
1535 <column name="statistics" key="rx_frame_err">
1536 Number of frame alignment errors.
1538 <column name="statistics" key="rx_over_err">
1539 Number of packets with RX overrun.
1541 <column name="statistics" key="rx_crc_err">
1542 Number of CRC errors.
1544 <column name="statistics" key="rx_errors">
1545 Total number of receive errors, greater than or equal to the sum of
1549 <group title="Statistics: Transmit errors">
1550 <column name="statistics" key="tx_dropped">
1551 Number of packets dropped by TX.
1553 <column name="statistics" key="collisions">
1554 Number of collisions.
1556 <column name="statistics" key="tx_errors">
1557 Total number of transmit errors, greater than or equal to the sum of
1563 <group title="Ingress Policing">
1565 These settings control ingress policing for packets received on this
1566 interface. On a physical interface, this limits the rate at which
1567 traffic is allowed into the system from the outside; on a virtual
1568 interface (one connected to a virtual machine), this limits the rate at
1569 which the VM is able to transmit.
1572 Policing is a simple form of quality-of-service that simply drops
1573 packets received in excess of the configured rate. Due to its
1574 simplicity, policing is usually less accurate and less effective than
1575 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1576 table="Queue"/> tables).
1579 Policing is currently implemented only on Linux. The Linux
1580 implementation uses a simple ``token bucket'' approach:
1584 The size of the bucket corresponds to <ref
1585 column="ingress_policing_burst"/>. Initially the bucket is full.
1588 Whenever a packet is received, its size (converted to tokens) is
1589 compared to the number of tokens currently in the bucket. If the
1590 required number of tokens are available, they are removed and the
1591 packet is forwarded. Otherwise, the packet is dropped.
1594 Whenever it is not full, the bucket is refilled with tokens at the
1595 rate specified by <ref column="ingress_policing_rate"/>.
1599 Policing interacts badly with some network protocols, and especially
1600 with fragmented IP packets. Suppose that there is enough network
1601 activity to keep the bucket nearly empty all the time. Then this token
1602 bucket algorithm will forward a single packet every so often, with the
1603 period depending on packet size and on the configured rate. All of the
1604 fragments of an IP packets are normally transmitted back-to-back, as a
1605 group. In such a situation, therefore, only one of these fragments
1606 will be forwarded and the rest will be dropped. IP does not provide
1607 any way for the intended recipient to ask for only the remaining
1608 fragments. In such a case there are two likely possibilities for what
1609 will happen next: either all of the fragments will eventually be
1610 retransmitted (as TCP will do), in which case the same problem will
1611 recur, or the sender will not realize that its packet has been dropped
1612 and data will simply be lost (as some UDP-based protocols will do).
1613 Either way, it is possible that no forward progress will ever occur.
1615 <column name="ingress_policing_rate">
1617 Maximum rate for data received on this interface, in kbps. Data
1618 received faster than this rate is dropped. Set to <code>0</code>
1619 (the default) to disable policing.
1623 <column name="ingress_policing_burst">
1624 <p>Maximum burst size for data received on this interface, in kb. The
1625 default burst size if set to <code>0</code> is 1000 kb. This value
1626 has no effect if <ref column="ingress_policing_rate"/>
1627 is <code>0</code>.</p>
1629 Specifying a larger burst size lets the algorithm be more forgiving,
1630 which is important for protocols like TCP that react severely to
1631 dropped packets. The burst size should be at least the size of the
1632 interface's MTU. Specifying a value that is numerically at least as
1633 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1634 closer to achieving the full rate.
1639 <group title="Connectivity Fault Management">
1641 802.1ag Connectivity Fault Management (CFM) allows a group of
1642 Maintenance Points (MPs) called a Maintenance Association (MA) to
1643 detect connectivity problems with each other. MPs within a MA should
1644 have complete and exclusive interconnectivity. This is verified by
1645 occasionally broadcasting Continuity Check Messages (CCMs) at a
1646 configurable transmission interval.
1650 According to the 802.1ag specification, each Maintenance Point should
1651 be configured out-of-band with a list of Remote Maintenance Points it
1652 should have connectivity to. Open vSwitch differs from the
1653 specification in this area. It simply assumes the link is faulted if
1654 no Remote Maintenance Points are reachable, and considers it not
1658 <column name="cfm_mpid">
1659 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1660 a Maintenance Association. The MPID is used to identify this endpoint
1661 to other Maintenance Points in the MA. Each end of a link being
1662 monitored should have a different MPID. Must be configured to enable
1663 CFM on this <ref table="Interface"/>.
1666 <column name="cfm_fault">
1668 Indicates a connectivity fault triggered by an inability to receive
1669 heartbeats from any remote endpoint. When a fault is triggered on
1670 <ref table="Interface"/>s participating in bonds, they will be
1674 Faults can be triggered for several reasons. Most importantly they
1675 are triggered when no CCMs are received for a period of 3.5 times the
1676 transmission interval. Faults are also triggered when any CCMs
1677 indicate that a Remote Maintenance Point is not receiving CCMs but
1678 able to send them. Finally, a fault is triggered if a CCM is
1679 received which indicates unexpected configuration. Notably, this
1680 case arises when a CCM is received which advertises the local MPID.
1684 <column name="cfm_fault_status" key="recv">
1685 Indicates a CFM fault was triggered due to a lack of CCMs received on
1686 the <ref table="Interface"/>.
1689 <column name="cfm_fault_status" key="rdi">
1690 Indicates a CFM fault was triggered due to the reception of a CCM with
1691 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1692 are not receiving CCMs themselves. This typically indicates a
1693 unidirectional connectivity failure.
1696 <column name="cfm_fault_status" key="maid">
1697 Indicates a CFM fault was triggered due to the reception of a CCM with
1698 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1699 with an identification number in addition to the MPID called the MAID.
1700 Open vSwitch only supports receiving CCM broadcasts tagged with the
1701 MAID it uses internally.
1704 <column name="cfm_fault_status" key="loopback">
1705 Indicates a CFM fault was triggered due to the reception of a CCM
1706 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1707 column of this <ref table="Interface"/>. This may indicate a loop in
1711 <column name="cfm_fault_status" key="overflow">
1712 Indicates a CFM fault was triggered because the CFM module received
1713 CCMs from more remote endpoints than it can keep track of.
1716 <column name="cfm_fault_status" key="override">
1717 Indicates a CFM fault was manually triggered by an administrator using
1718 an <code>ovs-appctl</code> command.
1721 <column name="cfm_fault_status" key="interval">
1722 Indicates a CFM fault was triggered due to the reception of a CCM
1723 frame having an invalid interval.
1726 <column name="cfm_fault_status" key="sequence">
1727 Indicates a CFM fault was triggered because the CFM module received
1728 a CCM frame with a sequence number that it was not expecting.
1731 <column name="cfm_health">
1733 Indicates the health of the interface as a percentage of CCM frames
1734 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1735 The health of an interface is undefined if it is communicating with
1736 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1737 healthy heartbeats are not received at the expected rate, and
1738 gradually improves as healthy heartbeats are received at the desired
1739 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1740 health of the interface is refreshed.
1743 As mentioned above, the faults can be triggered for several reasons.
1744 The link health will deteriorate even if heartbeats are received but
1745 they are reported to be unhealthy. An unhealthy heartbeat in this
1746 context is a heartbeat for which either some fault is set or is out
1747 of sequence. The interface health can be 100 only on receiving
1748 healthy heartbeats at the desired rate.
1752 <column name="cfm_remote_mpids">
1753 When CFM is properly configured, Open vSwitch will occasionally
1754 receive CCM broadcasts. These broadcasts contain the MPID of the
1755 sending Maintenance Point. The list of MPIDs from which this
1756 <ref table="Interface"/> is receiving broadcasts from is regularly
1757 collected and written to this column.
1760 <column name="other_config" key="cfm_interval"
1761 type='{"type": "integer"}'>
1763 The interval, in milliseconds, between transmissions of CFM
1764 heartbeats. Three missed heartbeat receptions indicate a
1769 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1770 60,000, or 600,000 ms are supported. Other values will be rounded
1771 down to the nearest value on the list. Extended mode (see <ref
1772 column="other_config" key="cfm_extended"/>) supports any interval up
1773 to 65,535 ms. In either mode, the default is 1000 ms.
1776 <p>We do not recommend using intervals less than 100 ms.</p>
1779 <column name="other_config" key="cfm_extended"
1780 type='{"type": "boolean"}'>
1781 When <code>true</code>, the CFM module operates in extended mode. This
1782 causes it to use a nonstandard destination address to avoid conflicting
1783 with compliant implementations which may be running concurrently on the
1784 network. Furthermore, extended mode increases the accuracy of the
1785 <code>cfm_interval</code> configuration parameter by breaking wire
1786 compatibility with 802.1ag compliant implementations. Defaults to
1789 <column name="other_config" key="cfm_opstate"
1790 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1791 When <code>down</code>, the CFM module marks all CCMs it generates as
1792 operationally down without triggering a fault. This allows remote
1793 maintenance points to choose not to forward traffic to the
1794 <ref table="Interface"/> on which this CFM module is running.
1795 Currently, in Open vSwitch, the opdown bit of CCMs affects
1796 <ref table="Interface"/>s participating in bonds, and the bundle
1797 OpenFlow action. This setting is ignored when CFM is not in extended
1798 mode. Defaults to <code>up</code>.
1801 <column name="other_config" key="cfm_ccm_vlan"
1802 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1803 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1804 with the given value. May be the string <code>random</code> in which
1805 case each CCM will be tagged with a different randomly generated VLAN.
1808 <column name="other_config" key="cfm_ccm_pcp"
1809 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1810 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1811 with the given PCP value. The VLAN ID of the tag is governed by the
1812 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1813 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1819 <group title="Bonding Configuration">
1820 <column name="other_config" key="bond-stable-id"
1821 type='{"type": "integer", "minInteger": 1}'>
1822 Used in <code>stable</code> bond mode to make slave
1823 selection decisions. Allocating <ref column="other_config"
1824 key="bond-stable-id"/> values consistently across interfaces
1825 participating in a bond will guarantee consistent slave selection
1826 decisions across <code>ovs-vswitchd</code> instances when using
1827 <code>stable</code> bonding mode.
1830 <column name="other_config" key="lacp-port-id"
1831 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1832 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1833 used in LACP negotiations to identify individual ports
1834 participating in a bond.
1837 <column name="other_config" key="lacp-port-priority"
1838 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1839 The LACP port priority of this <ref table="Interface"/>. In LACP
1840 negotiations <ref table="Interface"/>s with numerically lower
1841 priorities are preferred for aggregation.
1844 <column name="other_config" key="lacp-aggregation-key"
1845 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1846 The LACP aggregation key of this <ref table="Interface"/>. <ref
1847 table="Interface"/>s with different aggregation keys may not be active
1848 within a given <ref table="Port"/> at the same time.
1852 <group title="Virtual Machine Identifiers">
1854 These key-value pairs specifically apply to an interface that
1855 represents a virtual Ethernet interface connected to a virtual
1856 machine. These key-value pairs should not be present for other types
1857 of interfaces. Keys whose names end in <code>-uuid</code> have
1858 values that uniquely identify the entity in question. For a Citrix
1859 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1860 Other hypervisors may use other formats.
1863 <column name="external_ids" key="attached-mac">
1864 The MAC address programmed into the ``virtual hardware'' for this
1865 interface, in the form
1866 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1867 For Citrix XenServer, this is the value of the <code>MAC</code> field
1868 in the VIF record for this interface.
1871 <column name="external_ids" key="iface-id">
1872 A system-unique identifier for the interface. On XenServer, this will
1873 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1876 <column name="external_ids" key="iface-status"
1877 type='{"type": "string",
1878 "enum": ["set", ["active", "inactive"]]}'>
1880 Hypervisors may sometimes have more than one interface associated
1881 with a given <ref column="external_ids" key="iface-id"/>, only one of
1882 which is actually in use at a given time. For example, in some
1883 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1884 for a single <ref column="external_ids" key="iface-id"/>, but only
1885 uses one of them at a time. A hypervisor that behaves this way must
1886 mark the currently in use interface <code>active</code> and the
1887 others <code>inactive</code>. A hypervisor that never has more than
1888 one interface for a given <ref column="external_ids" key="iface-id"/>
1889 may mark that interface <code>active</code> or omit <ref
1890 column="external_ids" key="iface-status"/> entirely.
1894 During VM migration, a given <ref column="external_ids"
1895 key="iface-id"/> might transiently be marked <code>active</code> on
1896 two different hypervisors. That is, <code>active</code> means that
1897 this <ref column="external_ids" key="iface-id"/> is the active
1898 instance within a single hypervisor, not in a broader scope.
1902 <column name="external_ids" key="xs-vif-uuid">
1903 The virtual interface associated with this interface.
1906 <column name="external_ids" key="xs-network-uuid">
1907 The virtual network to which this interface is attached.
1910 <column name="external_ids" key="vm-id">
1911 The VM to which this interface belongs. On XenServer, this will be the
1912 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1915 <column name="external_ids" key="xs-vm-uuid">
1916 The VM to which this interface belongs.
1920 <group title="VLAN Splinters">
1922 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1923 with buggy network drivers in old versions of Linux that do not
1924 properly support VLANs when VLAN devices are not used, at some cost
1925 in memory and performance.
1929 When VLAN splinters are enabled on a particular interface, Open vSwitch
1930 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1931 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1932 received on the VLAN device is treated as if it had been received on
1933 the interface on the particular VLAN.
1937 VLAN splinters consider a VLAN to be in use if:
1942 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1943 table="Port"/> record.
1947 The VLAN is listed within the <ref table="Port" column="trunks"/>
1948 column of the <ref table="Port"/> record of an interface on which
1949 VLAN splinters are enabled.
1951 An empty <ref table="Port" column="trunks"/> does not influence the
1952 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1953 will exceed the current 1,024 port per datapath limit.
1957 An OpenFlow flow within any bridge matches the VLAN.
1962 The same set of in-use VLANs applies to every interface on which VLAN
1963 splinters are enabled. That is, the set is not chosen separately for
1964 each interface but selected once as the union of all in-use VLANs based
1969 It does not make sense to enable VLAN splinters on an interface for an
1970 access port, or on an interface that is not a physical port.
1974 VLAN splinters are deprecated. When broken device drivers are no
1975 longer in widespread use, we will delete this feature.
1978 <column name="other_config" key="enable-vlan-splinters"
1979 type='{"type": "boolean"}'>
1981 Set to <code>true</code> to enable VLAN splinters on this interface.
1982 Defaults to <code>false</code>.
1986 VLAN splinters increase kernel and userspace memory overhead, so do
1987 not use them unless they are needed.
1991 VLAN splinters do not support 802.1p priority tags. Received
1992 priorities will appear to be 0, regardless of their actual values,
1993 and priorities on transmitted packets will also be cleared to 0.
1998 <group title="Common Columns">
1999 The overall purpose of these columns is described under <code>Common
2000 Columns</code> at the beginning of this document.
2002 <column name="other_config"/>
2003 <column name="external_ids"/>
2007 <table name="Flow_Table" title="OpenFlow table configuration">
2008 <p>Configuration for a particular OpenFlow table.</p>
2010 <column name="name">
2011 The table's name. Set this column to change the name that controllers
2012 will receive when they request table statistics, e.g. <code>ovs-ofctl
2013 dump-tables</code>. The name does not affect switch behavior.
2016 <column name="flow_limit">
2017 If set, limits the number of flows that may be added to the table. Open
2018 vSwitch may limit the number of flows in a table for other reasons,
2019 e.g. due to hardware limitations or for resource availability or
2020 performance reasons.
2023 <column name="overflow_policy">
2025 Controls the switch's behavior when an OpenFlow flow table modification
2026 request would add flows in excess of <ref column="flow_limit"/>. The
2027 supported values are:
2031 <dt><code>refuse</code></dt>
2033 Refuse to add the flow or flows. This is also the default policy
2034 when <ref column="overflow_policy"/> is unset.
2037 <dt><code>evict</code></dt>
2039 Delete the flow that will expire soonest. See <ref column="groups"/>
2045 <column name="groups">
2047 When <ref column="overflow_policy"/> is <code>evict</code>, this
2048 controls how flows are chosen for eviction when the flow table would
2049 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2050 of NXM fields or sub-fields, each of which takes one of the forms
2051 <code><var>field</var>[]</code> or
2052 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2053 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2054 <code>nicira-ext.h</code> for a complete list of NXM field names.
2058 When a flow must be evicted due to overflow, the flow to evict is
2059 chosen through an approximation of the following algorithm:
2064 Divide the flows in the table into groups based on the values of the
2065 specified fields or subfields, so that all of the flows in a given
2066 group have the same values for those fields. If a flow does not
2067 specify a given field, that field's value is treated as 0.
2071 Consider the flows in the largest group, that is, the group that
2072 contains the greatest number of flows. If two or more groups all
2073 have the same largest number of flows, consider the flows in all of
2078 Among the flows under consideration, choose the flow that expires
2079 soonest for eviction.
2084 The eviction process only considers flows that have an idle timeout or
2085 a hard timeout. That is, eviction never deletes permanent flows.
2086 (Permanent flows do count against <ref column="flow_limit"/>.
2090 Open vSwitch ignores any invalid or unknown field specifications.
2094 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2095 column has no effect.
2100 <table name="QoS" title="Quality of Service configuration">
2101 <p>Quality of Service (QoS) configuration for each Port that
2104 <column name="type">
2105 <p>The type of QoS to implement. The currently defined types are
2108 <dt><code>linux-htb</code></dt>
2110 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2111 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2112 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2113 for information on how this classifier works and how to configure it.
2117 <dt><code>linux-hfsc</code></dt>
2119 Linux "Hierarchical Fair Service Curve" classifier.
2120 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2121 information on how this classifier works.
2126 <column name="queues">
2127 <p>A map from queue numbers to <ref table="Queue"/> records. The
2128 supported range of queue numbers depend on <ref column="type"/>. The
2129 queue numbers are the same as the <code>queue_id</code> used in
2130 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2134 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2135 actions when no specific queue has been set. When no configuration for
2136 queue 0 is present, it is automatically configured as if a <ref
2137 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2138 and <ref table="Queue" column="other_config"/> columns had been
2140 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2141 this case. With some queuing disciplines, this dropped all packets
2142 destined for the default queue.)
2146 <group title="Configuration for linux-htb and linux-hfsc">
2148 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2149 the following key-value pair:
2152 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2153 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2154 specified, for physical interfaces, the default is the link rate. For
2155 other interfaces or if the link rate cannot be determined, the default
2156 is currently 100 Mbps.
2160 <group title="Common Columns">
2161 The overall purpose of these columns is described under <code>Common
2162 Columns</code> at the beginning of this document.
2164 <column name="other_config"/>
2165 <column name="external_ids"/>
2169 <table name="Queue" title="QoS output queue.">
2170 <p>A configuration for a port output queue, used in configuring Quality of
2171 Service (QoS) features. May be referenced by <ref column="queues"
2172 table="QoS"/> column in <ref table="QoS"/> table.</p>
2174 <column name="dscp">
2175 If set, Open vSwitch will mark all traffic egressing this
2176 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2177 default <ref table="Queue"/> is only marked if it was explicitly selected
2178 as the <ref table="Queue"/> at the time the packet was output. If unset,
2179 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2183 <group title="Configuration for linux-htb QoS">
2185 <ref table="QoS"/> <ref table="QoS" column="type"/>
2186 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2187 It has the following key-value pairs defined.
2190 <column name="other_config" key="min-rate"
2191 type='{"type": "integer", "minInteger": 1}'>
2192 Minimum guaranteed bandwidth, in bit/s.
2195 <column name="other_config" key="max-rate"
2196 type='{"type": "integer", "minInteger": 1}'>
2197 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2198 queue's rate will not be allowed to exceed the specified value, even
2199 if excess bandwidth is available. If unspecified, defaults to no
2203 <column name="other_config" key="burst"
2204 type='{"type": "integer", "minInteger": 1}'>
2205 Burst size, in bits. This is the maximum amount of ``credits'' that a
2206 queue can accumulate while it is idle. Optional. Details of the
2207 <code>linux-htb</code> implementation require a minimum burst size, so
2208 a too-small <code>burst</code> will be silently ignored.
2211 <column name="other_config" key="priority"
2212 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2213 A queue with a smaller <code>priority</code> will receive all the
2214 excess bandwidth that it can use before a queue with a larger value
2215 receives any. Specific priority values are unimportant; only relative
2216 ordering matters. Defaults to 0 if unspecified.
2220 <group title="Configuration for linux-hfsc QoS">
2222 <ref table="QoS"/> <ref table="QoS" column="type"/>
2223 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2224 It has the following key-value pairs defined.
2227 <column name="other_config" key="min-rate"
2228 type='{"type": "integer", "minInteger": 1}'>
2229 Minimum guaranteed bandwidth, in bit/s.
2232 <column name="other_config" key="max-rate"
2233 type='{"type": "integer", "minInteger": 1}'>
2234 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2235 queue's rate will not be allowed to exceed the specified value, even if
2236 excess bandwidth is available. If unspecified, defaults to no
2241 <group title="Common Columns">
2242 The overall purpose of these columns is described under <code>Common
2243 Columns</code> at the beginning of this document.
2245 <column name="other_config"/>
2246 <column name="external_ids"/>
2250 <table name="Mirror" title="Port mirroring.">
2251 <p>A port mirror within a <ref table="Bridge"/>.</p>
2252 <p>A port mirror configures a bridge to send selected frames to special
2253 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2254 traffic may also be referred to as SPAN or RSPAN, depending on how
2255 the mirrored traffic is sent.</p>
2257 <column name="name">
2258 Arbitrary identifier for the <ref table="Mirror"/>.
2261 <group title="Selecting Packets for Mirroring">
2263 To be selected for mirroring, a given packet must enter or leave the
2264 bridge through a selected port and it must also be in one of the
2268 <column name="select_all">
2269 If true, every packet arriving or departing on any port is
2270 selected for mirroring.
2273 <column name="select_dst_port">
2274 Ports on which departing packets are selected for mirroring.
2277 <column name="select_src_port">
2278 Ports on which arriving packets are selected for mirroring.
2281 <column name="select_vlan">
2282 VLANs on which packets are selected for mirroring. An empty set
2283 selects packets on all VLANs.
2287 <group title="Mirroring Destination Configuration">
2289 These columns are mutually exclusive. Exactly one of them must be
2293 <column name="output_port">
2294 <p>Output port for selected packets, if nonempty.</p>
2295 <p>Specifying a port for mirror output reserves that port exclusively
2296 for mirroring. No frames other than those selected for mirroring
2298 will be forwarded to the port, and any frames received on the port
2299 will be discarded.</p>
2301 The output port may be any kind of port supported by Open vSwitch.
2302 It may be, for example, a physical port (sometimes called SPAN) or a
2307 <column name="output_vlan">
2308 <p>Output VLAN for selected packets, if nonempty.</p>
2309 <p>The frames will be sent out all ports that trunk
2310 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2311 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2312 trunk port, the frame's VLAN tag will be set to
2313 <ref column="output_vlan"/>, replacing any existing tag; when it is
2314 sent out an implicit VLAN port, the frame will not be tagged. This
2315 type of mirroring is sometimes called RSPAN.</p>
2317 The following destination MAC addresses will not be mirrored to a
2318 VLAN to avoid confusing switches that interpret the protocols that
2322 <dt><code>01:80:c2:00:00:00</code></dt>
2323 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
2325 <dt><code>01:80:c2:00:00:01</code></dt>
2326 <dd>IEEE Pause frame.</dd>
2328 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
2329 <dd>Other reserved protocols.</dd>
2331 <dt><code>01:00:0c:cc:cc:cc</code></dt>
2333 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
2334 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
2338 <dt><code>01:00:0c:cc:cc:cd</code></dt>
2339 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
2341 <dt><code>01:00:0c:cd:cd:cd</code></dt>
2342 <dd>Cisco STP Uplink Fast.</dd>
2344 <dt><code>01:00:0c:00:00:00</code></dt>
2345 <dd>Cisco Inter Switch Link.</dd>
2347 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2348 contains unmanaged switches. Consider an unmanaged physical switch
2349 with two ports: port 1, connected to an end host, and port 2,
2350 connected to an Open vSwitch configured to mirror received packets
2351 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2352 port 1 that the physical switch forwards to port 2. The Open vSwitch
2353 forwards this packet to its destination and then reflects it back on
2354 port 2 in VLAN 123. This reflected packet causes the unmanaged
2355 physical switch to replace the MAC learning table entry, which
2356 correctly pointed to port 1, with one that incorrectly points to port
2357 2. Afterward, the physical switch will direct packets destined for
2358 the end host to the Open vSwitch on port 2, instead of to the end
2359 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2360 desired in this scenario, then the physical switch must be replaced
2361 by one that learns Ethernet addresses on a per-VLAN basis. In
2362 addition, learning should be disabled on the VLAN containing mirrored
2363 traffic. If this is not done then intermediate switches will learn
2364 the MAC address of each end host from the mirrored traffic. If
2365 packets being sent to that end host are also mirrored, then they will
2366 be dropped since the switch will attempt to send them out the input
2367 port. Disabling learning for the VLAN will cause the switch to
2368 correctly send the packet out all ports configured for that VLAN. If
2369 Open vSwitch is being used as an intermediate switch, learning can be
2370 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2371 in the appropriate <ref table="Bridge"/> table or tables.</p>
2373 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2374 VLAN and should generally be preferred.
2379 <group title="Statistics: Mirror counters">
2381 Key-value pairs that report mirror statistics.
2383 <column name="statistics" key="tx_packets">
2384 Number of packets transmitted through this mirror.
2386 <column name="statistics" key="tx_bytes">
2387 Number of bytes transmitted through this mirror.
2391 <group title="Common Columns">
2392 The overall purpose of these columns is described under <code>Common
2393 Columns</code> at the beginning of this document.
2395 <column name="external_ids"/>
2399 <table name="Controller" title="OpenFlow controller configuration.">
2400 <p>An OpenFlow controller.</p>
2403 Open vSwitch supports two kinds of OpenFlow controllers:
2407 <dt>Primary controllers</dt>
2410 This is the kind of controller envisioned by the OpenFlow 1.0
2411 specification. Usually, a primary controller implements a network
2412 policy by taking charge of the switch's flow table.
2416 Open vSwitch initiates and maintains persistent connections to
2417 primary controllers, retrying the connection each time it fails or
2418 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2419 <ref table="Bridge"/> table applies to primary controllers.
2423 Open vSwitch permits a bridge to have any number of primary
2424 controllers. When multiple controllers are configured, Open
2425 vSwitch connects to all of them simultaneously. Because
2426 OpenFlow 1.0 does not specify how multiple controllers
2427 coordinate in interacting with a single switch, more than
2428 one primary controller should be specified only if the
2429 controllers are themselves designed to coordinate with each
2430 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2431 vendor extension may be useful for this.)
2434 <dt>Service controllers</dt>
2437 These kinds of OpenFlow controller connections are intended for
2438 occasional support and maintenance use, e.g. with
2439 <code>ovs-ofctl</code>. Usually a service controller connects only
2440 briefly to inspect or modify some of a switch's state.
2444 Open vSwitch listens for incoming connections from service
2445 controllers. The service controllers initiate and, if necessary,
2446 maintain the connections from their end. The <ref table="Bridge"
2447 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2448 not apply to service controllers.
2452 Open vSwitch supports configuring any number of service controllers.
2458 The <ref column="target"/> determines the type of controller.
2461 <group title="Core Features">
2462 <column name="target">
2463 <p>Connection method for controller.</p>
2465 The following connection methods are currently supported for primary
2469 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2471 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2472 the given <var>ip</var>, which must be expressed as an IP address
2473 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2474 column in the <ref table="Open_vSwitch"/> table must point to a
2475 valid SSL configuration when this form is used.</p>
2476 <p>SSL support is an optional feature that is not always built as
2477 part of Open vSwitch.</p>
2479 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2480 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2481 the given <var>ip</var>, which must be expressed as an IP address
2482 (not a DNS name).</dd>
2485 The following connection methods are currently supported for service
2489 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2492 Listens for SSL connections on the specified TCP <var>port</var>
2493 (default: 6633). If <var>ip</var>, which must be expressed as an
2494 IP address (not a DNS name), is specified, then connections are
2495 restricted to the specified local IP address.
2498 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2499 table="Open_vSwitch"/> table must point to a valid SSL
2500 configuration when this form is used.
2502 <p>SSL support is an optional feature that is not always built as
2503 part of Open vSwitch.</p>
2505 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2507 Listens for connections on the specified TCP <var>port</var>
2508 (default: 6633). If <var>ip</var>, which must be expressed as an
2509 IP address (not a DNS name), is specified, then connections are
2510 restricted to the specified local IP address.
2513 <p>When multiple controllers are configured for a single bridge, the
2514 <ref column="target"/> values must be unique. Duplicate
2515 <ref column="target"/> values yield unspecified results.</p>
2518 <column name="connection_mode">
2519 <p>If it is specified, this setting must be one of the following
2520 strings that describes how Open vSwitch contacts this OpenFlow
2521 controller over the network:</p>
2524 <dt><code>in-band</code></dt>
2525 <dd>In this mode, this controller's OpenFlow traffic travels over the
2526 bridge associated with the controller. With this setting, Open
2527 vSwitch allows traffic to and from the controller regardless of the
2528 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2529 would never be able to connect to the controller, because it did
2530 not have a flow to enable it.) This is the most common connection
2531 mode because it is not necessary to maintain two independent
2533 <dt><code>out-of-band</code></dt>
2534 <dd>In this mode, OpenFlow traffic uses a control network separate
2535 from the bridge associated with this controller, that is, the
2536 bridge does not use any of its own network devices to communicate
2537 with the controller. The control network must be configured
2538 separately, before or after <code>ovs-vswitchd</code> is started.
2542 <p>If not specified, the default is implementation-specific.</p>
2546 <group title="Controller Failure Detection and Handling">
2547 <column name="max_backoff">
2548 Maximum number of milliseconds to wait between connection attempts.
2549 Default is implementation-specific.
2552 <column name="inactivity_probe">
2553 Maximum number of milliseconds of idle time on connection to
2554 controller before sending an inactivity probe message. If Open
2555 vSwitch does not communicate with the controller for the specified
2556 number of seconds, it will send a probe. If a response is not
2557 received for the same additional amount of time, Open vSwitch
2558 assumes the connection has been broken and attempts to reconnect.
2559 Default is implementation-specific. A value of 0 disables
2564 <group title="Asynchronous Message Configuration">
2566 OpenFlow switches send certain messages to controllers spontanenously,
2567 that is, not in response to any request from the controller. These
2568 messages are called ``asynchronous messages.'' These columns allow
2569 asynchronous messages to be limited or disabled to ensure the best use
2570 of network resources.
2573 <column name="enable_async_messages">
2574 The OpenFlow protocol enables asynchronous messages at time of
2575 connection establishment, which means that a controller can receive
2576 asynchronous messages, potentially many of them, even if it turns them
2577 off immediately after connecting. Set this column to
2578 <code>false</code> to change Open vSwitch behavior to disable, by
2579 default, all asynchronous messages. The controller can use the
2580 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2581 on any messages that it does want to receive, if any.
2584 <column name="controller_rate_limit">
2586 The maximum rate at which the switch will forward packets to the
2587 OpenFlow controller, in packets per second. This feature prevents a
2588 single bridge from overwhelming the controller. If not specified,
2589 the default is implementation-specific.
2593 In addition, when a high rate triggers rate-limiting, Open vSwitch
2594 queues controller packets for each port and transmits them to the
2595 controller at the configured rate. The <ref
2596 column="controller_burst_limit"/> value limits the number of queued
2597 packets. Ports on a bridge share the packet queue fairly.
2601 Open vSwitch maintains two such packet rate-limiters per bridge: one
2602 for packets sent up to the controller because they do not correspond
2603 to any flow, and the other for packets sent up to the controller by
2604 request through flow actions. When both rate-limiters are filled with
2605 packets, the actual rate that packets are sent to the controller is
2606 up to twice the specified rate.
2610 <column name="controller_burst_limit">
2611 In conjunction with <ref column="controller_rate_limit"/>,
2612 the maximum number of unused packet credits that the bridge will
2613 allow to accumulate, in packets. If not specified, the default
2614 is implementation-specific.
2618 <group title="Additional In-Band Configuration">
2619 <p>These values are considered only in in-band control mode (see
2620 <ref column="connection_mode"/>).</p>
2622 <p>When multiple controllers are configured on a single bridge, there
2623 should be only one set of unique values in these columns. If different
2624 values are set for these columns in different controllers, the effect
2627 <column name="local_ip">
2628 The IP address to configure on the local port,
2629 e.g. <code>192.168.0.123</code>. If this value is unset, then
2630 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2634 <column name="local_netmask">
2635 The IP netmask to configure on the local port,
2636 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2637 but this value is unset, then the default is chosen based on whether
2638 the IP address is class A, B, or C.
2641 <column name="local_gateway">
2642 The IP address of the gateway to configure on the local port, as a
2643 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2644 this network has no gateway.
2648 <group title="Controller Status">
2649 <column name="is_connected">
2650 <code>true</code> if currently connected to this controller,
2651 <code>false</code> otherwise.
2655 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2656 <p>The level of authority this controller has on the associated
2657 bridge. Possible values are:</p>
2659 <dt><code>other</code></dt>
2660 <dd>Allows the controller access to all OpenFlow features.</dd>
2661 <dt><code>master</code></dt>
2662 <dd>Equivalent to <code>other</code>, except that there may be at
2663 most one master controller at a time. When a controller configures
2664 itself as <code>master</code>, any existing master is demoted to
2665 the <code>slave</code>role.</dd>
2666 <dt><code>slave</code></dt>
2667 <dd>Allows the controller read-only access to OpenFlow features.
2668 Attempts to modify the flow table will be rejected with an
2669 error. Slave controllers do not receive OFPT_PACKET_IN or
2670 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2675 <column name="status" key="last_error">
2676 A human-readable description of the last error on the connection
2677 to the controller; i.e. <code>strerror(errno)</code>. This key
2678 will exist only if an error has occurred.
2681 <column name="status" key="state"
2682 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2684 The state of the connection to the controller:
2687 <dt><code>VOID</code></dt>
2688 <dd>Connection is disabled.</dd>
2690 <dt><code>BACKOFF</code></dt>
2691 <dd>Attempting to reconnect at an increasing period.</dd>
2693 <dt><code>CONNECTING</code></dt>
2694 <dd>Attempting to connect.</dd>
2696 <dt><code>ACTIVE</code></dt>
2697 <dd>Connected, remote host responsive.</dd>
2699 <dt><code>IDLE</code></dt>
2700 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2703 These values may change in the future. They are provided only for
2708 <column name="status" key="sec_since_connect"
2709 type='{"type": "integer", "minInteger": 0}'>
2710 The amount of time since this controller last successfully connected to
2711 the switch (in seconds). Value is empty if controller has never
2712 successfully connected.
2715 <column name="status" key="sec_since_disconnect"
2716 type='{"type": "integer", "minInteger": 1}'>
2717 The amount of time since this controller last disconnected from
2718 the switch (in seconds). Value is empty if controller has never
2723 <group title="Connection Parameters">
2725 Additional configuration for a connection between the controller
2726 and the Open vSwitch.
2729 <column name="other_config" key="dscp"
2730 type='{"type": "integer"}'>
2731 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2732 in the Type of Service (TOS) field in the IP header. DSCP provides a
2733 mechanism to classify the network traffic and provide Quality of
2734 Service (QoS) on IP networks.
2736 The DSCP value specified here is used when establishing the connection
2737 between the controller and the Open vSwitch. The connection must be
2738 reset for the new DSCP values to take effect. If no value is
2739 specified, a default value of 48 is chosen. Valid DSCP values must be
2740 in the range 0 to 63.
2745 <group title="Common Columns">
2746 The overall purpose of these columns is described under <code>Common
2747 Columns</code> at the beginning of this document.
2749 <column name="external_ids"/>
2750 <column name="other_config"/>
2754 <table name="Manager" title="OVSDB management connection.">
2756 Configuration for a database connection to an Open vSwitch database
2761 This table primarily configures the Open vSwitch database
2762 (<code>ovsdb-server</code>), not the Open vSwitch switch
2763 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2764 what connections should be treated as in-band.
2768 The Open vSwitch database server can initiate and maintain active
2769 connections to remote clients. It can also listen for database
2773 <group title="Core Features">
2774 <column name="target">
2775 <p>Connection method for managers.</p>
2777 The following connection methods are currently supported:
2780 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2783 The specified SSL <var>port</var> (default: 6632) on the host at
2784 the given <var>ip</var>, which must be expressed as an IP address
2785 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2786 column in the <ref table="Open_vSwitch"/> table must point to a
2787 valid SSL configuration when this form is used.
2790 SSL support is an optional feature that is not always built as
2791 part of Open vSwitch.
2795 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2797 The specified TCP <var>port</var> (default: 6632) on the host at
2798 the given <var>ip</var>, which must be expressed as an IP address
2801 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2804 Listens for SSL connections on the specified TCP <var>port</var>
2805 (default: 6632). If <var>ip</var>, which must be expressed as an
2806 IP address (not a DNS name), is specified, then connections are
2807 restricted to the specified local IP address.
2810 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2811 table="Open_vSwitch"/> table must point to a valid SSL
2812 configuration when this form is used.
2815 SSL support is an optional feature that is not always built as
2816 part of Open vSwitch.
2819 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2821 Listens for connections on the specified TCP <var>port</var>
2822 (default: 6632). If <var>ip</var>, which must be expressed as an
2823 IP address (not a DNS name), is specified, then connections are
2824 restricted to the specified local IP address.
2827 <p>When multiple managers are configured, the <ref column="target"/>
2828 values must be unique. Duplicate <ref column="target"/> values yield
2829 unspecified results.</p>
2832 <column name="connection_mode">
2834 If it is specified, this setting must be one of the following strings
2835 that describes how Open vSwitch contacts this OVSDB client over the
2840 <dt><code>in-band</code></dt>
2842 In this mode, this connection's traffic travels over a bridge
2843 managed by Open vSwitch. With this setting, Open vSwitch allows
2844 traffic to and from the client regardless of the contents of the
2845 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2846 to connect to the client, because it did not have a flow to enable
2847 it.) This is the most common connection mode because it is not
2848 necessary to maintain two independent networks.
2850 <dt><code>out-of-band</code></dt>
2852 In this mode, the client's traffic uses a control network separate
2853 from that managed by Open vSwitch, that is, Open vSwitch does not
2854 use any of its own network devices to communicate with the client.
2855 The control network must be configured separately, before or after
2856 <code>ovs-vswitchd</code> is started.
2861 If not specified, the default is implementation-specific.
2866 <group title="Client Failure Detection and Handling">
2867 <column name="max_backoff">
2868 Maximum number of milliseconds to wait between connection attempts.
2869 Default is implementation-specific.
2872 <column name="inactivity_probe">
2873 Maximum number of milliseconds of idle time on connection to the client
2874 before sending an inactivity probe message. If Open vSwitch does not
2875 communicate with the client for the specified number of seconds, it
2876 will send a probe. If a response is not received for the same
2877 additional amount of time, Open vSwitch assumes the connection has been
2878 broken and attempts to reconnect. Default is implementation-specific.
2879 A value of 0 disables inactivity probes.
2883 <group title="Status">
2884 <column name="is_connected">
2885 <code>true</code> if currently connected to this manager,
2886 <code>false</code> otherwise.
2889 <column name="status" key="last_error">
2890 A human-readable description of the last error on the connection
2891 to the manager; i.e. <code>strerror(errno)</code>. This key
2892 will exist only if an error has occurred.
2895 <column name="status" key="state"
2896 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2898 The state of the connection to the manager:
2901 <dt><code>VOID</code></dt>
2902 <dd>Connection is disabled.</dd>
2904 <dt><code>BACKOFF</code></dt>
2905 <dd>Attempting to reconnect at an increasing period.</dd>
2907 <dt><code>CONNECTING</code></dt>
2908 <dd>Attempting to connect.</dd>
2910 <dt><code>ACTIVE</code></dt>
2911 <dd>Connected, remote host responsive.</dd>
2913 <dt><code>IDLE</code></dt>
2914 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2917 These values may change in the future. They are provided only for
2922 <column name="status" key="sec_since_connect"
2923 type='{"type": "integer", "minInteger": 0}'>
2924 The amount of time since this manager last successfully connected
2925 to the database (in seconds). Value is empty if manager has never
2926 successfully connected.
2929 <column name="status" key="sec_since_disconnect"
2930 type='{"type": "integer", "minInteger": 0}'>
2931 The amount of time since this manager last disconnected from the
2932 database (in seconds). Value is empty if manager has never
2936 <column name="status" key="locks_held">
2937 Space-separated list of the names of OVSDB locks that the connection
2938 holds. Omitted if the connection does not hold any locks.
2941 <column name="status" key="locks_waiting">
2942 Space-separated list of the names of OVSDB locks that the connection is
2943 currently waiting to acquire. Omitted if the connection is not waiting
2947 <column name="status" key="locks_lost">
2948 Space-separated list of the names of OVSDB locks that the connection
2949 has had stolen by another OVSDB client. Omitted if no locks have been
2950 stolen from this connection.
2953 <column name="status" key="n_connections"
2954 type='{"type": "integer", "minInteger": 2}'>
2956 When <ref column="target"/> specifies a connection method that
2957 listens for inbound connections (e.g. <code>ptcp:</code> or
2958 <code>pssl:</code>) and more than one connection is actually active,
2959 the value is the number of active connections. Otherwise, this
2960 key-value pair is omitted.
2963 When multiple connections are active, status columns and key-value
2964 pairs (other than this one) report the status of one arbitrarily
2970 <group title="Connection Parameters">
2972 Additional configuration for a connection between the manager
2973 and the Open vSwitch Database.
2976 <column name="other_config" key="dscp"
2977 type='{"type": "integer"}'>
2978 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2979 in the Type of Service (TOS) field in the IP header. DSCP provides a
2980 mechanism to classify the network traffic and provide Quality of
2981 Service (QoS) on IP networks.
2983 The DSCP value specified here is used when establishing the connection
2984 between the manager and the Open vSwitch. The connection must be
2985 reset for the new DSCP values to take effect. If no value is
2986 specified, a default value of 48 is chosen. Valid DSCP values must be
2987 in the range 0 to 63.
2991 <group title="Common Columns">
2992 The overall purpose of these columns is described under <code>Common
2993 Columns</code> at the beginning of this document.
2995 <column name="external_ids"/>
2996 <column name="other_config"/>
3000 <table name="NetFlow">
3001 A NetFlow target. NetFlow is a protocol that exports a number of
3002 details about terminating IP flows, such as the principals involved
3005 <column name="targets">
3006 NetFlow targets in the form
3007 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3008 must be specified numerically, not as a DNS name.
3011 <column name="engine_id">
3012 Engine ID to use in NetFlow messages. Defaults to datapath index
3016 <column name="engine_type">
3017 Engine type to use in NetFlow messages. Defaults to datapath
3018 index if not specified.
3021 <column name="active_timeout">
3022 The interval at which NetFlow records are sent for flows that are
3023 still active, in seconds. A value of <code>0</code> requests the
3024 default timeout (currently 600 seconds); a value of <code>-1</code>
3025 disables active timeouts.
3028 <column name="add_id_to_interface">
3029 <p>If this column's value is <code>false</code>, the ingress and egress
3030 interface fields of NetFlow flow records are derived from OpenFlow port
3031 numbers. When it is <code>true</code>, the 7 most significant bits of
3032 these fields will be replaced by the least significant 7 bits of the
3033 engine id. This is useful because many NetFlow collectors do not
3034 expect multiple switches to be sending messages from the same host, so
3035 they do not store the engine information which could be used to
3036 disambiguate the traffic.</p>
3037 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3040 <group title="Common Columns">
3041 The overall purpose of these columns is described under <code>Common
3042 Columns</code> at the beginning of this document.
3044 <column name="external_ids"/>
3049 SSL configuration for an Open_vSwitch.
3051 <column name="private_key">
3052 Name of a PEM file containing the private key used as the switch's
3053 identity for SSL connections to the controller.
3056 <column name="certificate">
3057 Name of a PEM file containing a certificate, signed by the
3058 certificate authority (CA) used by the controller and manager,
3059 that certifies the switch's private key, identifying a trustworthy
3063 <column name="ca_cert">
3064 Name of a PEM file containing the CA certificate used to verify
3065 that the switch is connected to a trustworthy controller.
3068 <column name="bootstrap_ca_cert">
3069 If set to <code>true</code>, then Open vSwitch will attempt to
3070 obtain the CA certificate from the controller on its first SSL
3071 connection and save it to the named PEM file. If it is successful,
3072 it will immediately drop the connection and reconnect, and from then
3073 on all SSL connections must be authenticated by a certificate signed
3074 by the CA certificate thus obtained. <em>This option exposes the
3075 SSL connection to a man-in-the-middle attack obtaining the initial
3076 CA certificate.</em> It may still be useful for bootstrapping.
3079 <group title="Common Columns">
3080 The overall purpose of these columns is described under <code>Common
3081 Columns</code> at the beginning of this document.
3083 <column name="external_ids"/>
3087 <table name="sFlow">
3088 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3091 <column name="agent">
3092 Name of the network device whose IP address should be reported as the
3093 ``agent address'' to collectors. If not specified, the agent device is
3094 figured from the first target address and the routing table. If the
3095 routing table does not contain a route to the target, the IP address
3096 defaults to the <ref table="Controller" column="local_ip"/> in the
3097 collector's <ref table="Controller"/>. If an agent IP address cannot be
3098 determined any of these ways, sFlow is disabled.
3101 <column name="header">
3102 Number of bytes of a sampled packet to send to the collector.
3103 If not specified, the default is 128 bytes.
3106 <column name="polling">
3107 Polling rate in seconds to send port statistics to the collector.
3108 If not specified, defaults to 30 seconds.
3111 <column name="sampling">
3112 Rate at which packets should be sampled and sent to the collector.
3113 If not specified, defaults to 400, which means one out of 400
3114 packets, on average, will be sent to the collector.
3117 <column name="targets">
3118 sFlow targets in the form
3119 <code><var>ip</var>:<var>port</var></code>.
3122 <group title="Common Columns">
3123 The overall purpose of these columns is described under <code>Common
3124 Columns</code> at the beginning of this document.
3126 <column name="external_ids"/>