1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="disable-in-band"
443 type='{"type": "boolean"}'>
444 If set to <code>true</code>, disable in-band control on the bridge
445 regardless of controller and manager settings.
448 <column name="other_config" key="in-band-queue"
449 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
450 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
451 that will be used by flows set up by in-band control on this bridge.
452 If unset, or if the port used by an in-band control flow does not have
453 QoS configured, or if the port does not have a queue with the specified
454 ID, the default queue is used instead.
458 <group title="Spanning Tree Configuration">
459 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
460 that ensures loop-free topologies. It allows redundant links to
461 be included in the network to provide automatic backup paths if
462 the active links fails.
464 <column name="stp_enable">
465 Enable spanning tree on the bridge. By default, STP is disabled
466 on bridges. Bond, internal, and mirror ports are not supported
467 and will not participate in the spanning tree.
470 <column name="other_config" key="stp-system-id">
471 The bridge's STP identifier (the lower 48 bits of the bridge-id)
473 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
474 By default, the identifier is the MAC address of the bridge.
477 <column name="other_config" key="stp-priority"
478 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
479 The bridge's relative priority value for determining the root
480 bridge (the upper 16 bits of the bridge-id). A bridge with the
481 lowest bridge-id is elected the root. By default, the priority
485 <column name="other_config" key="stp-hello-time"
486 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
487 The interval between transmissions of hello messages by
488 designated ports, in seconds. By default the hello interval is
492 <column name="other_config" key="stp-max-age"
493 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
494 The maximum age of the information transmitted by the bridge
495 when it is the root bridge, in seconds. By default, the maximum
499 <column name="other_config" key="stp-forward-delay"
500 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
501 The delay to wait between transitioning root and designated
502 ports to <code>forwarding</code>, in seconds. By default, the
503 forwarding delay is 15 seconds.
507 <group title="Other Features">
508 <column name="datapath_type">
509 Name of datapath provider. The kernel datapath has
510 type <code>system</code>. The userspace datapath has
511 type <code>netdev</code>.
514 <column name="external_ids" key="bridge-id">
515 A unique identifier of the bridge. On Citrix XenServer this will
516 commonly be the same as
517 <ref column="external_ids" key="xs-network-uuids"/>.
520 <column name="external_ids" key="xs-network-uuids">
521 Semicolon-delimited set of universally unique identifier(s) for the
522 network with which this bridge is associated on a Citrix XenServer
523 host. The network identifiers are RFC 4122 UUIDs as displayed by,
524 e.g., <code>xe network-list</code>.
527 <column name="other_config" key="hwaddr">
528 An Ethernet address in the form
529 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
530 to set the hardware address of the local port and influence the
534 <column name="other_config" key="flow-eviction-threshold"
535 type='{"type": "integer", "minInteger": 0}'>
537 A number of flows as a nonnegative integer. This sets number of
538 flows at which eviction from the kernel flow table will be triggered.
539 If there are a large number of flows then increasing this value to
540 around the number of flows present can result in reduced CPU usage
544 The default is 1000. Values below 100 will be rounded up to 100.
548 <column name="other_config" key="forward-bpdu"
549 type='{"type": "boolean"}'>
550 Option to allow forwarding of BPDU frames when NORMAL action is
551 invoked. Frames with reserved Ethernet addresses (e.g. STP
552 BPDU) will be forwarded when this option is enabled and the
553 switch is not providing that functionality. If STP is enabled
554 on the port, STP BPDUs will never be forwarded. If the Open
555 vSwitch bridge is used to connect different Ethernet networks,
556 and if Open vSwitch node does not run STP, then this option
557 should be enabled. Default is disabled, set to
558 <code>true</code> to enable.
560 The following destination MAC addresss will not be forwarded when this
563 <dt><code>01:80:c2:00:00:00</code></dt>
564 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
566 <dt><code>01:80:c2:00:00:01</code></dt>
567 <dd>IEEE Pause frame.</dd>
569 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
570 <dd>Other reserved protocols.</dd>
572 <dt><code>01:00:0c:cc:cc:cc</code></dt>
574 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
575 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
579 <dt><code>01:00:0c:cc:cc:cd</code></dt>
580 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
582 <dt><code>01:00:0c:cd:cd:cd</code></dt>
583 <dd>Cisco STP Uplink Fast.</dd>
585 <dt><code>01:00:0c:00:00:00</code></dt>
586 <dd>Cisco Inter Switch Link.</dd>
590 <column name="other_config" key="mac-aging-time"
591 type='{"type": "integer", "minInteger": 1}'>
593 The maximum number of seconds to retain a MAC learning entry for
594 which no packets have been seen. The default is currently 300
595 seconds (5 minutes). The value, if specified, is forced into a
596 reasonable range, currently 15 to 3600 seconds.
600 A short MAC aging time allows a network to more quickly detect that a
601 host is no longer connected to a switch port. However, it also makes
602 it more likely that packets will be flooded unnecessarily, when they
603 are addressed to a connected host that rarely transmits packets. To
604 reduce the incidence of unnecessary flooding, use a MAC aging time
605 longer than the maximum interval at which a host will ordinarily
611 <group title="Bridge Status">
613 Status information about bridges.
615 <column name="status">
616 Key-value pairs that report bridge status.
618 <column name="status" key="stp_bridge_id">
620 The bridge-id (in hex) used in spanning tree advertisements.
621 Configuring the bridge-id is described in the
622 <code>stp-system-id</code> and <code>stp-priority</code> keys
623 of the <code>other_config</code> section earlier.
626 <column name="status" key="stp_designated_root">
628 The designated root (in hex) for this spanning tree.
631 <column name="status" key="stp_root_path_cost">
633 The path cost of reaching the designated bridge. A lower
639 <group title="Common Columns">
640 The overall purpose of these columns is described under <code>Common
641 Columns</code> at the beginning of this document.
643 <column name="other_config"/>
644 <column name="external_ids"/>
648 <table name="Port" table="Port or bond configuration.">
649 <p>A port within a <ref table="Bridge"/>.</p>
650 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
651 <ref column="interfaces"/> column. Such a port logically
652 corresponds to a port on a physical Ethernet switch. A port
653 with more than one interface is a ``bonded port'' (see
654 <ref group="Bonding Configuration"/>).</p>
655 <p>Some properties that one might think as belonging to a port are actually
656 part of the port's <ref table="Interface"/> members.</p>
659 Port name. Should be alphanumeric and no more than about 8
660 bytes long. May be the same as the interface name, for
661 non-bonded ports. Must otherwise be unique among the names of
662 ports, interfaces, and bridges on a host.
665 <column name="interfaces">
666 The port's interfaces. If there is more than one, this is a
670 <group title="VLAN Configuration">
671 <p>Bridge ports support the following types of VLAN configuration:</p>
676 A trunk port carries packets on one or more specified VLANs
677 specified in the <ref column="trunks"/> column (often, on every
678 VLAN). A packet that ingresses on a trunk port is in the VLAN
679 specified in its 802.1Q header, or VLAN 0 if the packet has no
680 802.1Q header. A packet that egresses through a trunk port will
681 have an 802.1Q header if it has a nonzero VLAN ID.
685 Any packet that ingresses on a trunk port tagged with a VLAN that
686 the port does not trunk is dropped.
693 An access port carries packets on exactly one VLAN specified in the
694 <ref column="tag"/> column. Packets egressing on an access port
695 have no 802.1Q header.
699 Any packet with an 802.1Q header with a nonzero VLAN ID that
700 ingresses on an access port is dropped, regardless of whether the
701 VLAN ID in the header is the access port's VLAN ID.
705 <dt>native-tagged</dt>
707 A native-tagged port resembles a trunk port, with the exception that
708 a packet without an 802.1Q header that ingresses on a native-tagged
709 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
713 <dt>native-untagged</dt>
715 A native-untagged port resembles a native-tagged port, with the
716 exception that a packet that egresses on a native-untagged port in
717 the native VLAN will not have an 802.1Q header.
721 A packet will only egress through bridge ports that carry the VLAN of
722 the packet, as described by the rules above.
725 <column name="vlan_mode">
727 The VLAN mode of the port, as described above. When this column is
728 empty, a default mode is selected as follows:
732 If <ref column="tag"/> contains a value, the port is an access
733 port. The <ref column="trunks"/> column should be empty.
736 Otherwise, the port is a trunk port. The <ref column="trunks"/>
737 column value is honored if it is present.
744 For an access port, the port's implicitly tagged VLAN. For a
745 native-tagged or native-untagged port, the port's native VLAN. Must
746 be empty if this is a trunk port.
750 <column name="trunks">
752 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
753 or VLANs that this port trunks; if it is empty, then the port trunks
754 all VLANs. Must be empty if this is an access port.
757 A native-tagged or native-untagged port always trunks its native
758 VLAN, regardless of whether <ref column="trunks"/> includes that
763 <column name="other_config" key="priority-tags"
764 type='{"type": "boolean"}'>
766 An 802.1Q header contains two important pieces of information: a VLAN
767 ID and a priority. A frame with a zero VLAN ID, called a
768 ``priority-tagged'' frame, is supposed to be treated the same way as
769 a frame without an 802.1Q header at all (except for the priority).
773 However, some network elements ignore any frame that has 802.1Q
774 header at all, even when the VLAN ID is zero. Therefore, by default
775 Open vSwitch does not output priority-tagged frames, instead omitting
776 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
777 <code>true</code> to enable priority-tagged frames on a port.
781 Regardless of this setting, Open vSwitch omits the 802.1Q header on
782 output if both the VLAN ID and priority would be zero.
786 All frames output to native-tagged ports have a nonzero VLAN ID, so
787 this setting is not meaningful on native-tagged ports.
792 <group title="Bonding Configuration">
793 <p>A port that has more than one interface is a ``bonded port.'' Bonding
794 allows for load balancing and fail-over. Some kinds of bonding will
795 work with any kind of upstream switch:</p>
798 <dt><code>balance-slb</code></dt>
800 Balances flows among slaves based on source MAC address and output
801 VLAN, with periodic rebalancing as traffic patterns change.
804 <dt><code>active-backup</code></dt>
806 Assigns all flows to one slave, failing over to a backup slave when
807 the active slave is disabled.
812 The following modes require the upstream switch to support 802.3ad with
813 successful LACP negotiation:
817 <dt><code>balance-tcp</code></dt>
819 Balances flows among slaves based on L2, L3, and L4 protocol
820 information such as destination MAC address, IP address, and TCP
824 <dt><code>stable</code></dt>
826 <p>Attempts to always assign a given flow to the same slave
827 consistently. In an effort to maintain stability, no load
828 balancing is done. Uses a similar hashing strategy to
829 <code>balance-tcp</code>, always taking into account L3 and L4
830 fields even if LACP negotiations are unsuccessful. </p>
831 <p>Slave selection decisions are made based on <ref table="Interface"
832 column="other_config" key="bond-stable-id"/> if set. Otherwise,
833 OpenFlow port number is used. Decisions are consistent across all
834 <code>ovs-vswitchd</code> instances with equivalent
835 <ref table="Interface" column="other_config" key="bond-stable-id"/>
840 <p>These columns apply only to bonded ports. Their values are
841 otherwise ignored.</p>
843 <column name="bond_mode">
844 <p>The type of bonding used for a bonded port. Defaults to
845 <code>active-backup</code> if unset.
849 <column name="other_config" key="bond-hash-basis"
850 type='{"type": "integer"}'>
851 An integer hashed along with flows when choosing output slaves in load
852 balanced bonds. When changed, all flows will be assigned different
853 hash values possibly causing slave selection decisions to change. Does
854 not affect bonding modes which do not employ load balancing such as
855 <code>active-backup</code>.
858 <group title="Link Failure Detection">
860 An important part of link bonding is detecting that links are down so
861 that they may be disabled. These settings determine how Open vSwitch
862 detects link failure.
865 <column name="other_config" key="bond-detect-mode"
866 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
867 The means used to detect link failures. Defaults to
868 <code>carrier</code> which uses each interface's carrier to detect
869 failures. When set to <code>miimon</code>, will check for failures
870 by polling each interface's MII.
873 <column name="other_config" key="bond-miimon-interval"
874 type='{"type": "integer"}'>
875 The interval, in milliseconds, between successive attempts to poll
876 each interface's MII. Relevant only when <ref column="other_config"
877 key="bond-detect-mode"/> is <code>miimon</code>.
880 <column name="bond_updelay">
882 The number of milliseconds for which carrier must stay up on an
883 interface before the interface is considered to be up. Specify
884 <code>0</code> to enable the interface immediately.
888 This setting is honored only when at least one bonded interface is
889 already enabled. When no interfaces are enabled, then the first
890 bond interface to come up is enabled immediately.
894 <column name="bond_downdelay">
895 The number of milliseconds for which carrier must stay down on an
896 interface before the interface is considered to be down. Specify
897 <code>0</code> to disable the interface immediately.
901 <group title="LACP Configuration">
903 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
904 allows switches to automatically detect that they are connected by
905 multiple links and aggregate across those links. These settings
906 control LACP behavior.
910 Configures LACP on this port. LACP allows directly connected
911 switches to negotiate which links may be bonded. LACP may be enabled
912 on non-bonded ports for the benefit of any switches they may be
913 connected to. <code>active</code> ports are allowed to initiate LACP
914 negotiations. <code>passive</code> ports are allowed to participate
915 in LACP negotiations initiated by a remote switch, but not allowed to
916 initiate such negotiations themselves. If LACP is enabled on a port
917 whose partner switch does not support LACP, the bond will be
918 disabled. Defaults to <code>off</code> if unset.
921 <column name="other_config" key="lacp-system-id">
922 The LACP system ID of this <ref table="Port"/>. The system ID of a
923 LACP bond is used to identify itself to its partners. Must be a
924 nonzero MAC address. Defaults to the bridge Ethernet address if
928 <column name="other_config" key="lacp-system-priority"
929 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
930 The LACP system priority of this <ref table="Port"/>. In LACP
931 negotiations, link status decisions are made by the system with the
932 numerically lower priority.
935 <column name="other_config" key="lacp-time"
936 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
938 The LACP timing which should be used on this <ref table="Port"/>.
939 By default <code>slow</code> is used. When configured to be
940 <code>fast</code> LACP heartbeats are requested at a rate of once
941 per second causing connectivity problems to be detected more
942 quickly. In <code>slow</code> mode, heartbeats are requested at a
943 rate of once every 30 seconds.
948 <group title="SLB Configuration">
950 These settings control behavior when a bond is in
951 <code>balance-slb</code> mode, regardless of whether the bond was
952 intentionally configured in SLB mode or it fell back to SLB mode
953 because LACP negotiation failed.
956 <column name="other_config" key="bond-rebalance-interval"
957 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
958 For a load balanced bonded port, the number of milliseconds between
959 successive attempts to rebalance the bond, that is, to move flows
960 from one interface on the bond to another in an attempt to keep usage
961 of each interface roughly equal. If zero, load balancing is disabled
962 on the bond (carrier status changes still cause flows to move). If
963 less than 1000ms, the rebalance interval will be 1000ms.
967 <column name="bond_fake_iface">
968 For a bonded port, whether to create a fake internal interface with the
969 name of the port. Use only for compatibility with legacy software that
974 <group title="Spanning Tree Configuration">
975 <column name="other_config" key="stp-enable"
976 type='{"type": "boolean"}'>
977 If spanning tree is enabled on the bridge, member ports are
978 enabled by default (with the exception of bond, internal, and
979 mirror ports which do not work with STP). If this column's
980 value is <code>false</code> spanning tree is disabled on the
984 <column name="other_config" key="stp-port-num"
985 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
986 The port number used for the lower 8 bits of the port-id. By
987 default, the numbers will be assigned automatically. If any
988 port's number is manually configured on a bridge, then they
992 <column name="other_config" key="stp-port-priority"
993 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
994 The port's relative priority value for determining the root
995 port (the upper 8 bits of the port-id). A port with a lower
996 port-id will be chosen as the root port. By default, the
1000 <column name="other_config" key="stp-path-cost"
1001 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1002 Spanning tree path cost for the port. A lower number indicates
1003 a faster link. By default, the cost is based on the maximum
1008 <group title="Other Features">
1010 Quality of Service configuration for this port.
1014 The MAC address to use for this port for the purpose of choosing the
1015 bridge's MAC address. This column does not necessarily reflect the
1016 port's actual MAC address, nor will setting it change the port's actual
1020 <column name="fake_bridge">
1021 Does this port represent a sub-bridge for its tagged VLAN within the
1022 Bridge? See ovs-vsctl(8) for more information.
1025 <column name="external_ids" key="fake-bridge-id-*">
1026 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1027 column) are defined by prefixing a <ref table="Bridge"/> <ref
1028 table="Bridge" column="external_ids"/> key with
1029 <code>fake-bridge-</code>,
1030 e.g. <code>fake-bridge-xs-network-uuids</code>.
1034 <group title="Port Status">
1036 Status information about ports attached to bridges.
1038 <column name="status">
1039 Key-value pairs that report port status.
1041 <column name="status" key="stp_port_id">
1043 The port-id (in hex) used in spanning tree advertisements for
1044 this port. Configuring the port-id is described in the
1045 <code>stp-port-num</code> and <code>stp-port-priority</code>
1046 keys of the <code>other_config</code> section earlier.
1049 <column name="status" key="stp_state"
1050 type='{"type": "string", "enum": ["set",
1051 ["disabled", "listening", "learning",
1052 "forwarding", "blocking"]]}'>
1054 STP state of the port.
1057 <column name="status" key="stp_sec_in_state"
1058 type='{"type": "integer", "minInteger": 0}'>
1060 The amount of time (in seconds) port has been in the current
1064 <column name="status" key="stp_role"
1065 type='{"type": "string", "enum": ["set",
1066 ["root", "designated", "alternate"]]}'>
1068 STP role of the port.
1073 <group title="Port Statistics">
1075 Key-value pairs that report port statistics.
1077 <group title="Statistics: STP transmit and receive counters">
1078 <column name="statistics" key="stp_tx_count">
1079 Number of STP BPDUs sent on this port by the spanning
1082 <column name="statistics" key="stp_rx_count">
1083 Number of STP BPDUs received on this port and accepted by the
1084 spanning tree library.
1086 <column name="statistics" key="stp_error_count">
1087 Number of bad STP BPDUs received on this port. Bad BPDUs
1088 include runt packets and those with an unexpected protocol ID.
1093 <group title="Common Columns">
1094 The overall purpose of these columns is described under <code>Common
1095 Columns</code> at the beginning of this document.
1097 <column name="other_config"/>
1098 <column name="external_ids"/>
1102 <table name="Interface" title="One physical network device in a Port.">
1103 An interface within a <ref table="Port"/>.
1105 <group title="Core Features">
1106 <column name="name">
1107 Interface name. Should be alphanumeric and no more than about 8 bytes
1108 long. May be the same as the port name, for non-bonded ports. Must
1109 otherwise be unique among the names of ports, interfaces, and bridges
1114 <p>Ethernet address to set for this interface. If unset then the
1115 default MAC address is used:</p>
1117 <li>For the local interface, the default is the lowest-numbered MAC
1118 address among the other bridge ports, either the value of the
1119 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1120 if set, or its actual MAC (for bonded ports, the MAC of its slave
1121 whose name is first in alphabetical order). Internal ports and
1122 bridge ports that are used as port mirroring destinations (see the
1123 <ref table="Mirror"/> table) are ignored.</li>
1124 <li>For other internal interfaces, the default MAC is randomly
1126 <li>External interfaces typically have a MAC address associated with
1127 their hardware.</li>
1129 <p>Some interfaces may not have a software-controllable MAC
1133 <column name="ofport">
1134 <p>OpenFlow port number for this interface. Unlike most columns, this
1135 column's value should be set only by Open vSwitch itself. Other
1136 clients should set this column to an empty set (the default) when
1137 creating an <ref table="Interface"/>.</p>
1138 <p>Open vSwitch populates this column when the port number becomes
1139 known. If the interface is successfully added,
1140 <ref column="ofport"/> will be set to a number between 1 and 65535
1141 (generally either in the range 1 to 65279, inclusive, or 65534, the
1142 port number for the OpenFlow ``local port''). If the interface
1143 cannot be added then Open vSwitch sets this column
1148 <group title="System-Specific Details">
1149 <column name="type">
1151 The interface type, one of:
1155 <dt><code>system</code></dt>
1156 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1157 Sometimes referred to as ``external interfaces'' since they are
1158 generally connected to hardware external to that on which the Open
1159 vSwitch is running. The empty string is a synonym for
1160 <code>system</code>.</dd>
1162 <dt><code>internal</code></dt>
1163 <dd>A simulated network device that sends and receives traffic. An
1164 internal interface whose <ref column="name"/> is the same as its
1165 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1166 ``local interface.'' It does not make sense to bond an internal
1167 interface, so the terms ``port'' and ``interface'' are often used
1168 imprecisely for internal interfaces.</dd>
1170 <dt><code>tap</code></dt>
1171 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1173 <dt><code>gre</code></dt>
1175 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1176 tunnel. See <ref group="Tunnel Options"/> for information on
1177 configuring GRE tunnels.
1180 <dt><code>ipsec_gre</code></dt>
1182 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1186 <dt><code>capwap</code></dt>
1188 An Ethernet tunnel over the UDP transport portion of CAPWAP (RFC
1189 5415). This allows interoperability with certain switches that do
1190 not support GRE. Only the tunneling component of the protocol is
1191 implemented. UDP ports 58881 and 58882 are used as the source and
1192 destination ports respectively. CAPWAP is currently supported only
1193 with the Linux kernel datapath with kernel version 2.6.26 or later.
1196 <dt><code>patch</code></dt>
1198 A pair of virtual devices that act as a patch cable.
1201 <dt><code>null</code></dt>
1202 <dd>An ignored interface.</dd>
1207 <group title="Tunnel Options">
1209 These options apply to interfaces with <ref column="type"/> of
1210 <code>gre</code>, <code>ipsec_gre</code>, and <code>capwap</code>.
1214 Each tunnel must be uniquely identified by the combination of <ref
1215 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1216 column="options" key="local_ip"/>, and <ref column="options"
1217 key="in_key"/>. If two ports are defined that are the same except one
1218 has an optional identifier and the other does not, the more specific
1219 one is matched first. <ref column="options" key="in_key"/> is
1220 considered more specific than <ref column="options" key="local_ip"/> if
1221 a port defines one and another port defines the other.
1224 <column name="options" key="remote_ip">
1226 Required. The tunnel endpoint. Unicast and multicast endpoints are
1231 When a multicast endpoint is specified, a routing table lookup occurs
1232 only when the tunnel is created. Following a routing change, delete
1233 and then re-create the tunnel to force a new routing table lookup.
1237 <column name="options" key="local_ip">
1238 Optional. The destination IP that received packets must match.
1239 Default is to match all addresses. Must be omitted when <ref
1240 column="options" key="remote_ip"/> is a multicast address.
1243 <column name="options" key="in_key">
1244 <p>Optional. The key that received packets must contain, one of:</p>
1248 <code>0</code>. The tunnel receives packets with no key or with a
1249 key of 0. This is equivalent to specifying no <ref column="options"
1250 key="in_key"/> at all.
1253 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. The
1254 tunnel receives only packets with the specified key.
1257 The word <code>flow</code>. The tunnel accepts packets with any
1258 key. The key will be placed in the <code>tun_id</code> field for
1259 matching in the flow table. The <code>ovs-ofctl</code> manual page
1260 contains additional information about matching fields in OpenFlow
1269 <column name="options" key="out_key">
1270 <p>Optional. The key to be set on outgoing packets, one of:</p>
1274 <code>0</code>. Packets sent through the tunnel will have no key.
1275 This is equivalent to specifying no <ref column="options"
1276 key="out_key"/> at all.
1279 A positive 32-bit (for GRE) or 64-bit (for CAPWAP) number. Packets
1280 sent through the tunnel will have the specified key.
1283 The word <code>flow</code>. Packets sent through the tunnel will
1284 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1285 vendor extension (0 is used in the absence of an action). The
1286 <code>ovs-ofctl</code> manual page contains additional information
1287 about the Nicira OpenFlow vendor extensions.
1292 <column name="options" key="key">
1293 Optional. Shorthand to set <code>in_key</code> and
1294 <code>out_key</code> at the same time.
1297 <column name="options" key="tos">
1298 Optional. The value of the ToS bits to be set on the encapsulating
1299 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1300 zero. It may also be the word <code>inherit</code>, in which case
1301 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1302 (otherwise it will be 0). The ECN fields are always inherited.
1306 <column name="options" key="ttl">
1307 Optional. The TTL to be set on the encapsulating packet. It may also
1308 be the word <code>inherit</code>, in which case the TTL will be copied
1309 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1310 system default, typically 64). Default is the system default TTL.
1313 <column name="options" key="df_inherit" type='{"type": "boolean"}'>
1314 Optional. If enabled, the Don't Fragment bit will be copied from the
1315 inner IP headers (those of the encapsulated traffic) to the outer
1316 (tunnel) headers. Default is disabled; set to <code>true</code> to
1320 <column name="options" key="df_default"
1321 type='{"type": "boolean"}'>
1322 Optional. If enabled, the Don't Fragment bit will be set by default on
1323 tunnel headers if the <code>df_inherit</code> option is not set, or if
1324 the encapsulated packet is not IP. Default is enabled; set to
1325 <code>false</code> to disable.
1328 <column name="options" key="pmtud" type='{"type": "boolean"}'>
1329 Optional. Enable tunnel path MTU discovery. If enabled ``ICMP
1330 Destination Unreachable - Fragmentation Needed'' messages will be
1331 generated for IPv4 packets with the DF bit set and IPv6 packets above
1332 the minimum MTU if the packet size exceeds the path MTU minus the size
1333 of the tunnel headers. Note that this option causes behavior that is
1334 typically reserved for routers and therefore is not entirely in
1335 compliance with the IEEE 802.1D specification for bridges. Default is
1336 enabled; set to <code>false</code> to disable.
1339 <group title="Tunnel Options: gre only">
1341 Only <code>gre</code> interfaces support these options.
1344 <column name="options" key="header_cache" type='{"type": "boolean"}'>
1345 Enable caching of tunnel headers and the output path. This can lead
1346 to a significant performance increase without changing behavior. In
1347 general it should not be necessary to adjust this setting. However,
1348 the caching can bypass certain components of the IP stack (such as
1349 <code>iptables</code>) and it may be useful to disable it if these
1350 features are required or as a debugging measure. Default is enabled,
1351 set to <code>false</code> to disable.
1355 <group title="Tunnel Options: gre and ipsec_gre only">
1357 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1361 <column name="options" key="csum" type='{"type": "boolean"}'>
1363 Optional. Compute GRE checksums on outgoing packets. Default is
1364 disabled, set to <code>true</code> to enable. Checksums present on
1365 incoming packets will be validated regardless of this setting.
1369 GRE checksums impose a significant performance penalty because they
1370 cover the entire packet. The encapsulated L3, L4, and L7 packet
1371 contents typically have their own checksums, so this additional
1372 checksum only adds value for the GRE and encapsulated L2 headers.
1376 This option is supported for <code>ipsec_gre</code>, but not useful
1377 because GRE checksums are weaker than, and redundant with, IPsec
1378 payload authentication.
1383 <group title="Tunnel Options: ipsec_gre only">
1385 Only <code>ipsec_gre</code> interfaces support these options.
1388 <column name="options" key="peer_cert">
1389 Required for certificate authentication. A string containing the
1390 peer's certificate in PEM format. Additionally the host's
1391 certificate must be specified with the <code>certificate</code>
1395 <column name="options" key="certificate">
1396 Required for certificate authentication. The name of a PEM file
1397 containing a certificate that will be presented to the peer during
1401 <column name="options" key="private_key">
1402 Optional for certificate authentication. The name of a PEM file
1403 containing the private key associated with <code>certificate</code>.
1404 If <code>certificate</code> contains the private key, this option may
1408 <column name="options" key="psk">
1409 Required for pre-shared key authentication. Specifies a pre-shared
1410 key for authentication that must be identical on both sides of the
1416 <group title="Patch Options">
1418 Only <code>patch</code> interfaces support these options.
1421 <column name="options" key="peer">
1422 The <ref column="name"/> of the <ref table="Interface"/> for the other
1423 side of the patch. The named <ref table="Interface"/>'s own
1424 <code>peer</code> option must specify this <ref table="Interface"/>'s
1425 name. That is, the two patch interfaces must have reversed <ref
1426 column="name"/> and <code>peer</code> values.
1430 <group title="Interface Status">
1432 Status information about interfaces attached to bridges, updated every
1433 5 seconds. Not all interfaces have all of these properties; virtual
1434 interfaces don't have a link speed, for example. Non-applicable
1435 columns will have empty values.
1437 <column name="admin_state">
1439 The administrative state of the physical network link.
1443 <column name="link_state">
1445 The observed state of the physical network link. This is ordinarily
1446 the link's carrier status. If the interface's <ref table="Port"/> is
1447 a bond configured for miimon monitoring, it is instead the network
1448 link's miimon status.
1452 <column name="link_resets">
1454 The number of times Open vSwitch has observed the
1455 <ref column="link_state"/> of this <ref table="Interface"/> change.
1459 <column name="link_speed">
1461 The negotiated speed of the physical network link.
1462 Valid values are positive integers greater than 0.
1466 <column name="duplex">
1468 The duplex mode of the physical network link.
1474 The MTU (maximum transmission unit); i.e. the largest
1475 amount of data that can fit into a single Ethernet frame.
1476 The standard Ethernet MTU is 1500 bytes. Some physical media
1477 and many kinds of virtual interfaces can be configured with
1481 This column will be empty for an interface that does not
1482 have an MTU as, for example, some kinds of tunnels do not.
1486 <column name="lacp_current">
1487 Boolean value indicating LACP status for this interface. If true, this
1488 interface has current LACP information about its LACP partner. This
1489 information may be used to monitor the health of interfaces in a LACP
1490 enabled port. This column will be empty if LACP is not enabled.
1493 <column name="status">
1494 Key-value pairs that report port status. Supported status values are
1495 <ref column="type"/>-dependent; some interfaces may not have a valid
1496 <ref column="status" key="driver_name"/>, for example.
1499 <column name="status" key="driver_name">
1500 The name of the device driver controlling the network adapter.
1503 <column name="status" key="driver_version">
1504 The version string of the device driver controlling the network
1508 <column name="status" key="firmware_version">
1509 The version string of the network adapter's firmware, if available.
1512 <column name="status" key="source_ip">
1513 The source IP address used for an IPv4 tunnel end-point, such as
1514 <code>gre</code> or <code>capwap</code>.
1517 <column name="status" key="tunnel_egress_iface">
1518 Egress interface for tunnels. Currently only relevant for GRE and
1519 CAPWAP tunnels. On Linux systems, this column will show the name of
1520 the interface which is responsible for routing traffic destined for the
1521 configured <ref column="options" key="remote_ip"/>. This could be an
1522 internal interface such as a bridge port.
1525 <column name="status" key="tunnel_egress_iface_carrier"
1526 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1527 Whether carrier is detected on <ref column="status"
1528 key="tunnel_egress_iface"/>.
1532 <group title="Statistics">
1534 Key-value pairs that report interface statistics. The current
1535 implementation updates these counters periodically. Future
1536 implementations may update them when an interface is created, when they
1537 are queried (e.g. using an OVSDB <code>select</code> operation), and
1538 just before an interface is deleted due to virtual interface hot-unplug
1539 or VM shutdown, and perhaps at other times, but not on any regular
1543 These are the same statistics reported by OpenFlow in its <code>struct
1544 ofp_port_stats</code> structure. If an interface does not support a
1545 given statistic, then that pair is omitted.
1547 <group title="Statistics: Successful transmit and receive counters">
1548 <column name="statistics" key="rx_packets">
1549 Number of received packets.
1551 <column name="statistics" key="rx_bytes">
1552 Number of received bytes.
1554 <column name="statistics" key="tx_packets">
1555 Number of transmitted packets.
1557 <column name="statistics" key="tx_bytes">
1558 Number of transmitted bytes.
1561 <group title="Statistics: Receive errors">
1562 <column name="statistics" key="rx_dropped">
1563 Number of packets dropped by RX.
1565 <column name="statistics" key="rx_frame_err">
1566 Number of frame alignment errors.
1568 <column name="statistics" key="rx_over_err">
1569 Number of packets with RX overrun.
1571 <column name="statistics" key="rx_crc_err">
1572 Number of CRC errors.
1574 <column name="statistics" key="rx_errors">
1575 Total number of receive errors, greater than or equal to the sum of
1579 <group title="Statistics: Transmit errors">
1580 <column name="statistics" key="tx_dropped">
1581 Number of packets dropped by TX.
1583 <column name="statistics" key="collisions">
1584 Number of collisions.
1586 <column name="statistics" key="tx_errors">
1587 Total number of transmit errors, greater than or equal to the sum of
1593 <group title="Ingress Policing">
1595 These settings control ingress policing for packets received on this
1596 interface. On a physical interface, this limits the rate at which
1597 traffic is allowed into the system from the outside; on a virtual
1598 interface (one connected to a virtual machine), this limits the rate at
1599 which the VM is able to transmit.
1602 Policing is a simple form of quality-of-service that simply drops
1603 packets received in excess of the configured rate. Due to its
1604 simplicity, policing is usually less accurate and less effective than
1605 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1606 table="Queue"/> tables).
1609 Policing is currently implemented only on Linux. The Linux
1610 implementation uses a simple ``token bucket'' approach:
1614 The size of the bucket corresponds to <ref
1615 column="ingress_policing_burst"/>. Initially the bucket is full.
1618 Whenever a packet is received, its size (converted to tokens) is
1619 compared to the number of tokens currently in the bucket. If the
1620 required number of tokens are available, they are removed and the
1621 packet is forwarded. Otherwise, the packet is dropped.
1624 Whenever it is not full, the bucket is refilled with tokens at the
1625 rate specified by <ref column="ingress_policing_rate"/>.
1629 Policing interacts badly with some network protocols, and especially
1630 with fragmented IP packets. Suppose that there is enough network
1631 activity to keep the bucket nearly empty all the time. Then this token
1632 bucket algorithm will forward a single packet every so often, with the
1633 period depending on packet size and on the configured rate. All of the
1634 fragments of an IP packets are normally transmitted back-to-back, as a
1635 group. In such a situation, therefore, only one of these fragments
1636 will be forwarded and the rest will be dropped. IP does not provide
1637 any way for the intended recipient to ask for only the remaining
1638 fragments. In such a case there are two likely possibilities for what
1639 will happen next: either all of the fragments will eventually be
1640 retransmitted (as TCP will do), in which case the same problem will
1641 recur, or the sender will not realize that its packet has been dropped
1642 and data will simply be lost (as some UDP-based protocols will do).
1643 Either way, it is possible that no forward progress will ever occur.
1645 <column name="ingress_policing_rate">
1647 Maximum rate for data received on this interface, in kbps. Data
1648 received faster than this rate is dropped. Set to <code>0</code>
1649 (the default) to disable policing.
1653 <column name="ingress_policing_burst">
1654 <p>Maximum burst size for data received on this interface, in kb. The
1655 default burst size if set to <code>0</code> is 1000 kb. This value
1656 has no effect if <ref column="ingress_policing_rate"/>
1657 is <code>0</code>.</p>
1659 Specifying a larger burst size lets the algorithm be more forgiving,
1660 which is important for protocols like TCP that react severely to
1661 dropped packets. The burst size should be at least the size of the
1662 interface's MTU. Specifying a value that is numerically at least as
1663 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1664 closer to achieving the full rate.
1669 <group title="Connectivity Fault Management">
1671 802.1ag Connectivity Fault Management (CFM) allows a group of
1672 Maintenance Points (MPs) called a Maintenance Association (MA) to
1673 detect connectivity problems with each other. MPs within a MA should
1674 have complete and exclusive interconnectivity. This is verified by
1675 occasionally broadcasting Continuity Check Messages (CCMs) at a
1676 configurable transmission interval.
1680 According to the 802.1ag specification, each Maintenance Point should
1681 be configured out-of-band with a list of Remote Maintenance Points it
1682 should have connectivity to. Open vSwitch differs from the
1683 specification in this area. It simply assumes the link is faulted if
1684 no Remote Maintenance Points are reachable, and considers it not
1688 <column name="cfm_mpid">
1689 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1690 a Maintenance Association. The MPID is used to identify this endpoint
1691 to other Maintenance Points in the MA. Each end of a link being
1692 monitored should have a different MPID. Must be configured to enable
1693 CFM on this <ref table="Interface"/>.
1696 <column name="cfm_fault">
1698 Indicates a connectivity fault triggered by an inability to receive
1699 heartbeats from any remote endpoint. When a fault is triggered on
1700 <ref table="Interface"/>s participating in bonds, they will be
1704 Faults can be triggered for several reasons. Most importantly they
1705 are triggered when no CCMs are received for a period of 3.5 times the
1706 transmission interval. Faults are also triggered when any CCMs
1707 indicate that a Remote Maintenance Point is not receiving CCMs but
1708 able to send them. Finally, a fault is triggered if a CCM is
1709 received which indicates unexpected configuration. Notably, this
1710 case arises when a CCM is received which advertises the local MPID.
1714 <column name="cfm_fault_status" key="recv">
1715 Indicates a CFM fault was triggered due to a lack of CCMs received on
1716 the <ref table="Interface"/>.
1719 <column name="cfm_fault_status" key="rdi">
1720 Indicates a CFM fault was triggered due to the reception of a CCM with
1721 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1722 are not receiving CCMs themselves. This typically indicates a
1723 unidirectional connectivity failure.
1726 <column name="cfm_fault_status" key="maid">
1727 Indicates a CFM fault was triggered due to the reception of a CCM with
1728 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1729 with an identification number in addition to the MPID called the MAID.
1730 Open vSwitch only supports receiving CCM broadcasts tagged with the
1731 MAID it uses internally.
1734 <column name="cfm_fault_status" key="loopback">
1735 Indicates a CFM fault was triggered due to the reception of a CCM
1736 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1737 column of this <ref table="Interface"/>. This may indicate a loop in
1741 <column name="cfm_fault_status" key="overflow">
1742 Indicates a CFM fault was triggered because the CFM module received
1743 CCMs from more remote endpoints than it can keep track of.
1746 <column name="cfm_fault_status" key="override">
1747 Indicates a CFM fault was manually triggered by an administrator using
1748 an <code>ovs-appctl</code> command.
1751 <column name="cfm_fault_status" key="interval">
1752 Indicates a CFM fault was triggered due to the reception of a CCM
1753 frame having an invalid interval.
1756 <column name="cfm_fault_status" key="sequence">
1757 Indicates a CFM fault was triggered because the CFM module received
1758 a CCM frame with a sequence number that it was not expecting.
1761 <column name="cfm_health">
1763 Indicates the health of the interface as a percentage of CCM frames
1764 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1765 The health of an interface is undefined if it is communicating with
1766 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1767 healthy heartbeats are not received at the expected rate, and
1768 gradually improves as healthy heartbeats are received at the desired
1769 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1770 health of the interface is refreshed.
1773 As mentioned above, the faults can be triggered for several reasons.
1774 The link health will deteriorate even if heartbeats are received but
1775 they are reported to be unhealthy. An unhealthy heartbeat in this
1776 context is a heartbeat for which either some fault is set or is out
1777 of sequence. The interface health can be 100 only on receiving
1778 healthy heartbeats at the desired rate.
1782 <column name="cfm_remote_mpids">
1783 When CFM is properly configured, Open vSwitch will occasionally
1784 receive CCM broadcasts. These broadcasts contain the MPID of the
1785 sending Maintenance Point. The list of MPIDs from which this
1786 <ref table="Interface"/> is receiving broadcasts from is regularly
1787 collected and written to this column.
1790 <column name="other_config" key="cfm_interval"
1791 type='{"type": "integer"}'>
1793 The interval, in milliseconds, between transmissions of CFM
1794 heartbeats. Three missed heartbeat receptions indicate a
1799 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1800 60,000, or 600,000 ms are supported. Other values will be rounded
1801 down to the nearest value on the list. Extended mode (see <ref
1802 column="other_config" key="cfm_extended"/>) supports any interval up
1803 to 65,535 ms. In either mode, the default is 1000 ms.
1806 <p>We do not recommend using intervals less than 100 ms.</p>
1809 <column name="other_config" key="cfm_extended"
1810 type='{"type": "boolean"}'>
1811 When <code>true</code>, the CFM module operates in extended mode. This
1812 causes it to use a nonstandard destination address to avoid conflicting
1813 with compliant implementations which may be running concurrently on the
1814 network. Furthermore, extended mode increases the accuracy of the
1815 <code>cfm_interval</code> configuration parameter by breaking wire
1816 compatibility with 802.1ag compliant implementations. Defaults to
1819 <column name="other_config" key="cfm_opstate"
1820 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1821 When <code>down</code>, the CFM module marks all CCMs it generates as
1822 operationally down without triggering a fault. This allows remote
1823 maintenance points to choose not to forward traffic to the
1824 <ref table="Interface"/> on which this CFM module is running.
1825 Currently, in Open vSwitch, the opdown bit of CCMs affects
1826 <ref table="Interface"/>s participating in bonds, and the bundle
1827 OpenFlow action. This setting is ignored when CFM is not in extended
1828 mode. Defaults to <code>up</code>.
1831 <column name="other_config" key="cfm_ccm_vlan"
1832 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1833 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1834 with the given value. May be the string <code>random</code> in which
1835 case each CCM will be tagged with a different randomly generated VLAN.
1838 <column name="other_config" key="cfm_ccm_pcp"
1839 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1840 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1841 with the given PCP value. The VLAN ID of the tag is governed by the
1842 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1843 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1849 <group title="Bonding Configuration">
1850 <column name="other_config" key="bond-stable-id"
1851 type='{"type": "integer", "minInteger": 1}'>
1852 Used in <code>stable</code> bond mode to make slave
1853 selection decisions. Allocating <ref column="other_config"
1854 key="bond-stable-id"/> values consistently across interfaces
1855 participating in a bond will guarantee consistent slave selection
1856 decisions across <code>ovs-vswitchd</code> instances when using
1857 <code>stable</code> bonding mode.
1860 <column name="other_config" key="lacp-port-id"
1861 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1862 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1863 used in LACP negotiations to identify individual ports
1864 participating in a bond.
1867 <column name="other_config" key="lacp-port-priority"
1868 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1869 The LACP port priority of this <ref table="Interface"/>. In LACP
1870 negotiations <ref table="Interface"/>s with numerically lower
1871 priorities are preferred for aggregation.
1874 <column name="other_config" key="lacp-aggregation-key"
1875 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1876 The LACP aggregation key of this <ref table="Interface"/>. <ref
1877 table="Interface"/>s with different aggregation keys may not be active
1878 within a given <ref table="Port"/> at the same time.
1882 <group title="Virtual Machine Identifiers">
1884 These key-value pairs specifically apply to an interface that
1885 represents a virtual Ethernet interface connected to a virtual
1886 machine. These key-value pairs should not be present for other types
1887 of interfaces. Keys whose names end in <code>-uuid</code> have
1888 values that uniquely identify the entity in question. For a Citrix
1889 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1890 Other hypervisors may use other formats.
1893 <column name="external_ids" key="attached-mac">
1894 The MAC address programmed into the ``virtual hardware'' for this
1895 interface, in the form
1896 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1897 For Citrix XenServer, this is the value of the <code>MAC</code> field
1898 in the VIF record for this interface.
1901 <column name="external_ids" key="iface-id">
1902 A system-unique identifier for the interface. On XenServer, this will
1903 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1906 <column name="external_ids" key="iface-status"
1907 type='{"type": "string",
1908 "enum": ["set", ["active", "inactive"]]}'>
1910 Hypervisors may sometimes have more than one interface associated
1911 with a given <ref column="external_ids" key="iface-id"/>, only one of
1912 which is actually in use at a given time. For example, in some
1913 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1914 for a single <ref column="external_ids" key="iface-id"/>, but only
1915 uses one of them at a time. A hypervisor that behaves this way must
1916 mark the currently in use interface <code>active</code> and the
1917 others <code>inactive</code>. A hypervisor that never has more than
1918 one interface for a given <ref column="external_ids" key="iface-id"/>
1919 may mark that interface <code>active</code> or omit <ref
1920 column="external_ids" key="iface-status"/> entirely.
1924 During VM migration, a given <ref column="external_ids"
1925 key="iface-id"/> might transiently be marked <code>active</code> on
1926 two different hypervisors. That is, <code>active</code> means that
1927 this <ref column="external_ids" key="iface-id"/> is the active
1928 instance within a single hypervisor, not in a broader scope.
1932 <column name="external_ids" key="xs-vif-uuid">
1933 The virtual interface associated with this interface.
1936 <column name="external_ids" key="xs-network-uuid">
1937 The virtual network to which this interface is attached.
1940 <column name="external_ids" key="vm-id">
1941 The VM to which this interface belongs. On XenServer, this will be the
1942 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1945 <column name="external_ids" key="xs-vm-uuid">
1946 The VM to which this interface belongs.
1950 <group title="VLAN Splinters">
1952 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1953 with buggy network drivers in old versions of Linux that do not
1954 properly support VLANs when VLAN devices are not used, at some cost
1955 in memory and performance.
1959 When VLAN splinters are enabled on a particular interface, Open vSwitch
1960 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1961 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1962 received on the VLAN device is treated as if it had been received on
1963 the interface on the particular VLAN.
1967 VLAN splinters consider a VLAN to be in use if:
1972 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
1973 table="Port"/> record.
1977 The VLAN is listed within the <ref table="Port" column="trunks"/>
1978 column of the <ref table="Port"/> record of an interface on which
1979 VLAN splinters are enabled.
1981 An empty <ref table="Port" column="trunks"/> does not influence the
1982 in-use VLANs: creating 4,096 VLAN devices is impractical because it
1983 will exceed the current 1,024 port per datapath limit.
1987 An OpenFlow flow within any bridge matches the VLAN.
1992 The same set of in-use VLANs applies to every interface on which VLAN
1993 splinters are enabled. That is, the set is not chosen separately for
1994 each interface but selected once as the union of all in-use VLANs based
1999 It does not make sense to enable VLAN splinters on an interface for an
2000 access port, or on an interface that is not a physical port.
2004 VLAN splinters are deprecated. When broken device drivers are no
2005 longer in widespread use, we will delete this feature.
2008 <column name="other_config" key="enable-vlan-splinters"
2009 type='{"type": "boolean"}'>
2011 Set to <code>true</code> to enable VLAN splinters on this interface.
2012 Defaults to <code>false</code>.
2016 VLAN splinters increase kernel and userspace memory overhead, so do
2017 not use them unless they are needed.
2021 VLAN splinters do not support 802.1p priority tags. Received
2022 priorities will appear to be 0, regardless of their actual values,
2023 and priorities on transmitted packets will also be cleared to 0.
2028 <group title="Common Columns">
2029 The overall purpose of these columns is described under <code>Common
2030 Columns</code> at the beginning of this document.
2032 <column name="other_config"/>
2033 <column name="external_ids"/>
2037 <table name="Flow_Table" title="OpenFlow table configuration">
2038 <p>Configuration for a particular OpenFlow table.</p>
2040 <column name="name">
2041 The table's name. Set this column to change the name that controllers
2042 will receive when they request table statistics, e.g. <code>ovs-ofctl
2043 dump-tables</code>. The name does not affect switch behavior.
2046 <column name="flow_limit">
2047 If set, limits the number of flows that may be added to the table. Open
2048 vSwitch may limit the number of flows in a table for other reasons,
2049 e.g. due to hardware limitations or for resource availability or
2050 performance reasons.
2053 <column name="overflow_policy">
2055 Controls the switch's behavior when an OpenFlow flow table modification
2056 request would add flows in excess of <ref column="flow_limit"/>. The
2057 supported values are:
2061 <dt><code>refuse</code></dt>
2063 Refuse to add the flow or flows. This is also the default policy
2064 when <ref column="overflow_policy"/> is unset.
2067 <dt><code>evict</code></dt>
2069 Delete the flow that will expire soonest. See <ref column="groups"/>
2075 <column name="groups">
2077 When <ref column="overflow_policy"/> is <code>evict</code>, this
2078 controls how flows are chosen for eviction when the flow table would
2079 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2080 of NXM fields or sub-fields, each of which takes one of the forms
2081 <code><var>field</var>[]</code> or
2082 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2083 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2084 <code>nicira-ext.h</code> for a complete list of NXM field names.
2088 When a flow must be evicted due to overflow, the flow to evict is
2089 chosen through an approximation of the following algorithm:
2094 Divide the flows in the table into groups based on the values of the
2095 specified fields or subfields, so that all of the flows in a given
2096 group have the same values for those fields. If a flow does not
2097 specify a given field, that field's value is treated as 0.
2101 Consider the flows in the largest group, that is, the group that
2102 contains the greatest number of flows. If two or more groups all
2103 have the same largest number of flows, consider the flows in all of
2108 Among the flows under consideration, choose the flow that expires
2109 soonest for eviction.
2114 The eviction process only considers flows that have an idle timeout or
2115 a hard timeout. That is, eviction never deletes permanent flows.
2116 (Permanent flows do count against <ref column="flow_limit"/>.
2120 Open vSwitch ignores any invalid or unknown field specifications.
2124 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2125 column has no effect.
2130 <table name="QoS" title="Quality of Service configuration">
2131 <p>Quality of Service (QoS) configuration for each Port that
2134 <column name="type">
2135 <p>The type of QoS to implement. The currently defined types are
2138 <dt><code>linux-htb</code></dt>
2140 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2141 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2142 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2143 for information on how this classifier works and how to configure it.
2147 <dt><code>linux-hfsc</code></dt>
2149 Linux "Hierarchical Fair Service Curve" classifier.
2150 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2151 information on how this classifier works.
2156 <column name="queues">
2157 <p>A map from queue numbers to <ref table="Queue"/> records. The
2158 supported range of queue numbers depend on <ref column="type"/>. The
2159 queue numbers are the same as the <code>queue_id</code> used in
2160 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2164 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2165 actions when no specific queue has been set. When no configuration for
2166 queue 0 is present, it is automatically configured as if a <ref
2167 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2168 and <ref table="Queue" column="other_config"/> columns had been
2170 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2171 this case. With some queuing disciplines, this dropped all packets
2172 destined for the default queue.)
2176 <group title="Configuration for linux-htb and linux-hfsc">
2178 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2179 the following key-value pair:
2182 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2183 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2184 specified, for physical interfaces, the default is the link rate. For
2185 other interfaces or if the link rate cannot be determined, the default
2186 is currently 100 Mbps.
2190 <group title="Common Columns">
2191 The overall purpose of these columns is described under <code>Common
2192 Columns</code> at the beginning of this document.
2194 <column name="other_config"/>
2195 <column name="external_ids"/>
2199 <table name="Queue" title="QoS output queue.">
2200 <p>A configuration for a port output queue, used in configuring Quality of
2201 Service (QoS) features. May be referenced by <ref column="queues"
2202 table="QoS"/> column in <ref table="QoS"/> table.</p>
2204 <column name="dscp">
2205 If set, Open vSwitch will mark all traffic egressing this
2206 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2207 default <ref table="Queue"/> is only marked if it was explicitly selected
2208 as the <ref table="Queue"/> at the time the packet was output. If unset,
2209 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2213 <group title="Configuration for linux-htb QoS">
2215 <ref table="QoS"/> <ref table="QoS" column="type"/>
2216 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2217 It has the following key-value pairs defined.
2220 <column name="other_config" key="min-rate"
2221 type='{"type": "integer", "minInteger": 1}'>
2222 Minimum guaranteed bandwidth, in bit/s.
2225 <column name="other_config" key="max-rate"
2226 type='{"type": "integer", "minInteger": 1}'>
2227 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2228 queue's rate will not be allowed to exceed the specified value, even
2229 if excess bandwidth is available. If unspecified, defaults to no
2233 <column name="other_config" key="burst"
2234 type='{"type": "integer", "minInteger": 1}'>
2235 Burst size, in bits. This is the maximum amount of ``credits'' that a
2236 queue can accumulate while it is idle. Optional. Details of the
2237 <code>linux-htb</code> implementation require a minimum burst size, so
2238 a too-small <code>burst</code> will be silently ignored.
2241 <column name="other_config" key="priority"
2242 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2243 A queue with a smaller <code>priority</code> will receive all the
2244 excess bandwidth that it can use before a queue with a larger value
2245 receives any. Specific priority values are unimportant; only relative
2246 ordering matters. Defaults to 0 if unspecified.
2250 <group title="Configuration for linux-hfsc QoS">
2252 <ref table="QoS"/> <ref table="QoS" column="type"/>
2253 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2254 It has the following key-value pairs defined.
2257 <column name="other_config" key="min-rate"
2258 type='{"type": "integer", "minInteger": 1}'>
2259 Minimum guaranteed bandwidth, in bit/s.
2262 <column name="other_config" key="max-rate"
2263 type='{"type": "integer", "minInteger": 1}'>
2264 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2265 queue's rate will not be allowed to exceed the specified value, even if
2266 excess bandwidth is available. If unspecified, defaults to no
2271 <group title="Common Columns">
2272 The overall purpose of these columns is described under <code>Common
2273 Columns</code> at the beginning of this document.
2275 <column name="other_config"/>
2276 <column name="external_ids"/>
2280 <table name="Mirror" title="Port mirroring.">
2281 <p>A port mirror within a <ref table="Bridge"/>.</p>
2282 <p>A port mirror configures a bridge to send selected frames to special
2283 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2284 traffic may also be referred to as SPAN or RSPAN, depending on how
2285 the mirrored traffic is sent.</p>
2287 <column name="name">
2288 Arbitrary identifier for the <ref table="Mirror"/>.
2291 <group title="Selecting Packets for Mirroring">
2293 To be selected for mirroring, a given packet must enter or leave the
2294 bridge through a selected port and it must also be in one of the
2298 <column name="select_all">
2299 If true, every packet arriving or departing on any port is
2300 selected for mirroring.
2303 <column name="select_dst_port">
2304 Ports on which departing packets are selected for mirroring.
2307 <column name="select_src_port">
2308 Ports on which arriving packets are selected for mirroring.
2311 <column name="select_vlan">
2312 VLANs on which packets are selected for mirroring. An empty set
2313 selects packets on all VLANs.
2317 <group title="Mirroring Destination Configuration">
2319 These columns are mutually exclusive. Exactly one of them must be
2323 <column name="output_port">
2324 <p>Output port for selected packets, if nonempty.</p>
2325 <p>Specifying a port for mirror output reserves that port exclusively
2326 for mirroring. No frames other than those selected for mirroring
2328 will be forwarded to the port, and any frames received on the port
2329 will be discarded.</p>
2331 The output port may be any kind of port supported by Open vSwitch.
2332 It may be, for example, a physical port (sometimes called SPAN) or a
2337 <column name="output_vlan">
2338 <p>Output VLAN for selected packets, if nonempty.</p>
2339 <p>The frames will be sent out all ports that trunk
2340 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2341 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2342 trunk port, the frame's VLAN tag will be set to
2343 <ref column="output_vlan"/>, replacing any existing tag; when it is
2344 sent out an implicit VLAN port, the frame will not be tagged. This
2345 type of mirroring is sometimes called RSPAN.</p>
2347 See the documentation for
2348 <ref column="other_config" key="forward-bpdu"/> in the
2349 <ref table="Interface"/> table for a list of destination MAC
2350 addresses which will not be mirrored to a VLAN to avoid confusing
2351 switches that interpret the protocols that they represent.
2353 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2354 contains unmanaged switches. Consider an unmanaged physical switch
2355 with two ports: port 1, connected to an end host, and port 2,
2356 connected to an Open vSwitch configured to mirror received packets
2357 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2358 port 1 that the physical switch forwards to port 2. The Open vSwitch
2359 forwards this packet to its destination and then reflects it back on
2360 port 2 in VLAN 123. This reflected packet causes the unmanaged
2361 physical switch to replace the MAC learning table entry, which
2362 correctly pointed to port 1, with one that incorrectly points to port
2363 2. Afterward, the physical switch will direct packets destined for
2364 the end host to the Open vSwitch on port 2, instead of to the end
2365 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2366 desired in this scenario, then the physical switch must be replaced
2367 by one that learns Ethernet addresses on a per-VLAN basis. In
2368 addition, learning should be disabled on the VLAN containing mirrored
2369 traffic. If this is not done then intermediate switches will learn
2370 the MAC address of each end host from the mirrored traffic. If
2371 packets being sent to that end host are also mirrored, then they will
2372 be dropped since the switch will attempt to send them out the input
2373 port. Disabling learning for the VLAN will cause the switch to
2374 correctly send the packet out all ports configured for that VLAN. If
2375 Open vSwitch is being used as an intermediate switch, learning can be
2376 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2377 in the appropriate <ref table="Bridge"/> table or tables.</p>
2379 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2380 VLAN and should generally be preferred.
2385 <group title="Statistics: Mirror counters">
2387 Key-value pairs that report mirror statistics.
2389 <column name="statistics" key="tx_packets">
2390 Number of packets transmitted through this mirror.
2392 <column name="statistics" key="tx_bytes">
2393 Number of bytes transmitted through this mirror.
2397 <group title="Common Columns">
2398 The overall purpose of these columns is described under <code>Common
2399 Columns</code> at the beginning of this document.
2401 <column name="external_ids"/>
2405 <table name="Controller" title="OpenFlow controller configuration.">
2406 <p>An OpenFlow controller.</p>
2409 Open vSwitch supports two kinds of OpenFlow controllers:
2413 <dt>Primary controllers</dt>
2416 This is the kind of controller envisioned by the OpenFlow 1.0
2417 specification. Usually, a primary controller implements a network
2418 policy by taking charge of the switch's flow table.
2422 Open vSwitch initiates and maintains persistent connections to
2423 primary controllers, retrying the connection each time it fails or
2424 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2425 <ref table="Bridge"/> table applies to primary controllers.
2429 Open vSwitch permits a bridge to have any number of primary
2430 controllers. When multiple controllers are configured, Open
2431 vSwitch connects to all of them simultaneously. Because
2432 OpenFlow 1.0 does not specify how multiple controllers
2433 coordinate in interacting with a single switch, more than
2434 one primary controller should be specified only if the
2435 controllers are themselves designed to coordinate with each
2436 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2437 vendor extension may be useful for this.)
2440 <dt>Service controllers</dt>
2443 These kinds of OpenFlow controller connections are intended for
2444 occasional support and maintenance use, e.g. with
2445 <code>ovs-ofctl</code>. Usually a service controller connects only
2446 briefly to inspect or modify some of a switch's state.
2450 Open vSwitch listens for incoming connections from service
2451 controllers. The service controllers initiate and, if necessary,
2452 maintain the connections from their end. The <ref table="Bridge"
2453 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2454 not apply to service controllers.
2458 Open vSwitch supports configuring any number of service controllers.
2464 The <ref column="target"/> determines the type of controller.
2467 <group title="Core Features">
2468 <column name="target">
2469 <p>Connection method for controller.</p>
2471 The following connection methods are currently supported for primary
2475 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2477 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2478 the given <var>ip</var>, which must be expressed as an IP address
2479 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2480 column in the <ref table="Open_vSwitch"/> table must point to a
2481 valid SSL configuration when this form is used.</p>
2482 <p>SSL support is an optional feature that is not always built as
2483 part of Open vSwitch.</p>
2485 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2486 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2487 the given <var>ip</var>, which must be expressed as an IP address
2488 (not a DNS name).</dd>
2491 The following connection methods are currently supported for service
2495 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2498 Listens for SSL connections on the specified TCP <var>port</var>
2499 (default: 6633). If <var>ip</var>, which must be expressed as an
2500 IP address (not a DNS name), is specified, then connections are
2501 restricted to the specified local IP address.
2504 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2505 table="Open_vSwitch"/> table must point to a valid SSL
2506 configuration when this form is used.
2508 <p>SSL support is an optional feature that is not always built as
2509 part of Open vSwitch.</p>
2511 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2513 Listens for connections on the specified TCP <var>port</var>
2514 (default: 6633). If <var>ip</var>, which must be expressed as an
2515 IP address (not a DNS name), is specified, then connections are
2516 restricted to the specified local IP address.
2519 <p>When multiple controllers are configured for a single bridge, the
2520 <ref column="target"/> values must be unique. Duplicate
2521 <ref column="target"/> values yield unspecified results.</p>
2524 <column name="connection_mode">
2525 <p>If it is specified, this setting must be one of the following
2526 strings that describes how Open vSwitch contacts this OpenFlow
2527 controller over the network:</p>
2530 <dt><code>in-band</code></dt>
2531 <dd>In this mode, this controller's OpenFlow traffic travels over the
2532 bridge associated with the controller. With this setting, Open
2533 vSwitch allows traffic to and from the controller regardless of the
2534 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2535 would never be able to connect to the controller, because it did
2536 not have a flow to enable it.) This is the most common connection
2537 mode because it is not necessary to maintain two independent
2539 <dt><code>out-of-band</code></dt>
2540 <dd>In this mode, OpenFlow traffic uses a control network separate
2541 from the bridge associated with this controller, that is, the
2542 bridge does not use any of its own network devices to communicate
2543 with the controller. The control network must be configured
2544 separately, before or after <code>ovs-vswitchd</code> is started.
2548 <p>If not specified, the default is implementation-specific.</p>
2552 <group title="Controller Failure Detection and Handling">
2553 <column name="max_backoff">
2554 Maximum number of milliseconds to wait between connection attempts.
2555 Default is implementation-specific.
2558 <column name="inactivity_probe">
2559 Maximum number of milliseconds of idle time on connection to
2560 controller before sending an inactivity probe message. If Open
2561 vSwitch does not communicate with the controller for the specified
2562 number of seconds, it will send a probe. If a response is not
2563 received for the same additional amount of time, Open vSwitch
2564 assumes the connection has been broken and attempts to reconnect.
2565 Default is implementation-specific. A value of 0 disables
2570 <group title="Asynchronous Message Configuration">
2572 OpenFlow switches send certain messages to controllers spontanenously,
2573 that is, not in response to any request from the controller. These
2574 messages are called ``asynchronous messages.'' These columns allow
2575 asynchronous messages to be limited or disabled to ensure the best use
2576 of network resources.
2579 <column name="enable_async_messages">
2580 The OpenFlow protocol enables asynchronous messages at time of
2581 connection establishment, which means that a controller can receive
2582 asynchronous messages, potentially many of them, even if it turns them
2583 off immediately after connecting. Set this column to
2584 <code>false</code> to change Open vSwitch behavior to disable, by
2585 default, all asynchronous messages. The controller can use the
2586 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2587 on any messages that it does want to receive, if any.
2590 <column name="controller_rate_limit">
2592 The maximum rate at which the switch will forward packets to the
2593 OpenFlow controller, in packets per second. This feature prevents a
2594 single bridge from overwhelming the controller. If not specified,
2595 the default is implementation-specific.
2599 In addition, when a high rate triggers rate-limiting, Open vSwitch
2600 queues controller packets for each port and transmits them to the
2601 controller at the configured rate. The <ref
2602 column="controller_burst_limit"/> value limits the number of queued
2603 packets. Ports on a bridge share the packet queue fairly.
2607 Open vSwitch maintains two such packet rate-limiters per bridge: one
2608 for packets sent up to the controller because they do not correspond
2609 to any flow, and the other for packets sent up to the controller by
2610 request through flow actions. When both rate-limiters are filled with
2611 packets, the actual rate that packets are sent to the controller is
2612 up to twice the specified rate.
2616 <column name="controller_burst_limit">
2617 In conjunction with <ref column="controller_rate_limit"/>,
2618 the maximum number of unused packet credits that the bridge will
2619 allow to accumulate, in packets. If not specified, the default
2620 is implementation-specific.
2624 <group title="Additional In-Band Configuration">
2625 <p>These values are considered only in in-band control mode (see
2626 <ref column="connection_mode"/>).</p>
2628 <p>When multiple controllers are configured on a single bridge, there
2629 should be only one set of unique values in these columns. If different
2630 values are set for these columns in different controllers, the effect
2633 <column name="local_ip">
2634 The IP address to configure on the local port,
2635 e.g. <code>192.168.0.123</code>. If this value is unset, then
2636 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2640 <column name="local_netmask">
2641 The IP netmask to configure on the local port,
2642 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2643 but this value is unset, then the default is chosen based on whether
2644 the IP address is class A, B, or C.
2647 <column name="local_gateway">
2648 The IP address of the gateway to configure on the local port, as a
2649 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2650 this network has no gateway.
2654 <group title="Controller Status">
2655 <column name="is_connected">
2656 <code>true</code> if currently connected to this controller,
2657 <code>false</code> otherwise.
2661 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2662 <p>The level of authority this controller has on the associated
2663 bridge. Possible values are:</p>
2665 <dt><code>other</code></dt>
2666 <dd>Allows the controller access to all OpenFlow features.</dd>
2667 <dt><code>master</code></dt>
2668 <dd>Equivalent to <code>other</code>, except that there may be at
2669 most one master controller at a time. When a controller configures
2670 itself as <code>master</code>, any existing master is demoted to
2671 the <code>slave</code>role.</dd>
2672 <dt><code>slave</code></dt>
2673 <dd>Allows the controller read-only access to OpenFlow features.
2674 Attempts to modify the flow table will be rejected with an
2675 error. Slave controllers do not receive OFPT_PACKET_IN or
2676 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2681 <column name="status" key="last_error">
2682 A human-readable description of the last error on the connection
2683 to the controller; i.e. <code>strerror(errno)</code>. This key
2684 will exist only if an error has occurred.
2687 <column name="status" key="state"
2688 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2690 The state of the connection to the controller:
2693 <dt><code>VOID</code></dt>
2694 <dd>Connection is disabled.</dd>
2696 <dt><code>BACKOFF</code></dt>
2697 <dd>Attempting to reconnect at an increasing period.</dd>
2699 <dt><code>CONNECTING</code></dt>
2700 <dd>Attempting to connect.</dd>
2702 <dt><code>ACTIVE</code></dt>
2703 <dd>Connected, remote host responsive.</dd>
2705 <dt><code>IDLE</code></dt>
2706 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2709 These values may change in the future. They are provided only for
2714 <column name="status" key="sec_since_connect"
2715 type='{"type": "integer", "minInteger": 0}'>
2716 The amount of time since this controller last successfully connected to
2717 the switch (in seconds). Value is empty if controller has never
2718 successfully connected.
2721 <column name="status" key="sec_since_disconnect"
2722 type='{"type": "integer", "minInteger": 1}'>
2723 The amount of time since this controller last disconnected from
2724 the switch (in seconds). Value is empty if controller has never
2729 <group title="Connection Parameters">
2731 Additional configuration for a connection between the controller
2732 and the Open vSwitch.
2735 <column name="other_config" key="dscp"
2736 type='{"type": "integer"}'>
2737 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2738 in the Type of Service (TOS) field in the IP header. DSCP provides a
2739 mechanism to classify the network traffic and provide Quality of
2740 Service (QoS) on IP networks.
2742 The DSCP value specified here is used when establishing the connection
2743 between the controller and the Open vSwitch. The connection must be
2744 reset for the new DSCP values to take effect. If no value is
2745 specified, a default value of 48 is chosen. Valid DSCP values must be
2746 in the range 0 to 63.
2751 <group title="Common Columns">
2752 The overall purpose of these columns is described under <code>Common
2753 Columns</code> at the beginning of this document.
2755 <column name="external_ids"/>
2756 <column name="other_config"/>
2760 <table name="Manager" title="OVSDB management connection.">
2762 Configuration for a database connection to an Open vSwitch database
2767 This table primarily configures the Open vSwitch database
2768 (<code>ovsdb-server</code>), not the Open vSwitch switch
2769 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2770 what connections should be treated as in-band.
2774 The Open vSwitch database server can initiate and maintain active
2775 connections to remote clients. It can also listen for database
2779 <group title="Core Features">
2780 <column name="target">
2781 <p>Connection method for managers.</p>
2783 The following connection methods are currently supported:
2786 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2789 The specified SSL <var>port</var> (default: 6632) on the host at
2790 the given <var>ip</var>, which must be expressed as an IP address
2791 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2792 column in the <ref table="Open_vSwitch"/> table must point to a
2793 valid SSL configuration when this form is used.
2796 SSL support is an optional feature that is not always built as
2797 part of Open vSwitch.
2801 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2803 The specified TCP <var>port</var> (default: 6632) on the host at
2804 the given <var>ip</var>, which must be expressed as an IP address
2807 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2810 Listens for SSL connections on the specified TCP <var>port</var>
2811 (default: 6632). If <var>ip</var>, which must be expressed as an
2812 IP address (not a DNS name), is specified, then connections are
2813 restricted to the specified local IP address.
2816 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2817 table="Open_vSwitch"/> table must point to a valid SSL
2818 configuration when this form is used.
2821 SSL support is an optional feature that is not always built as
2822 part of Open vSwitch.
2825 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2827 Listens for connections on the specified TCP <var>port</var>
2828 (default: 6632). If <var>ip</var>, which must be expressed as an
2829 IP address (not a DNS name), is specified, then connections are
2830 restricted to the specified local IP address.
2833 <p>When multiple managers are configured, the <ref column="target"/>
2834 values must be unique. Duplicate <ref column="target"/> values yield
2835 unspecified results.</p>
2838 <column name="connection_mode">
2840 If it is specified, this setting must be one of the following strings
2841 that describes how Open vSwitch contacts this OVSDB client over the
2846 <dt><code>in-band</code></dt>
2848 In this mode, this connection's traffic travels over a bridge
2849 managed by Open vSwitch. With this setting, Open vSwitch allows
2850 traffic to and from the client regardless of the contents of the
2851 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2852 to connect to the client, because it did not have a flow to enable
2853 it.) This is the most common connection mode because it is not
2854 necessary to maintain two independent networks.
2856 <dt><code>out-of-band</code></dt>
2858 In this mode, the client's traffic uses a control network separate
2859 from that managed by Open vSwitch, that is, Open vSwitch does not
2860 use any of its own network devices to communicate with the client.
2861 The control network must be configured separately, before or after
2862 <code>ovs-vswitchd</code> is started.
2867 If not specified, the default is implementation-specific.
2872 <group title="Client Failure Detection and Handling">
2873 <column name="max_backoff">
2874 Maximum number of milliseconds to wait between connection attempts.
2875 Default is implementation-specific.
2878 <column name="inactivity_probe">
2879 Maximum number of milliseconds of idle time on connection to the client
2880 before sending an inactivity probe message. If Open vSwitch does not
2881 communicate with the client for the specified number of seconds, it
2882 will send a probe. If a response is not received for the same
2883 additional amount of time, Open vSwitch assumes the connection has been
2884 broken and attempts to reconnect. Default is implementation-specific.
2885 A value of 0 disables inactivity probes.
2889 <group title="Status">
2890 <column name="is_connected">
2891 <code>true</code> if currently connected to this manager,
2892 <code>false</code> otherwise.
2895 <column name="status" key="last_error">
2896 A human-readable description of the last error on the connection
2897 to the manager; i.e. <code>strerror(errno)</code>. This key
2898 will exist only if an error has occurred.
2901 <column name="status" key="state"
2902 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2904 The state of the connection to the manager:
2907 <dt><code>VOID</code></dt>
2908 <dd>Connection is disabled.</dd>
2910 <dt><code>BACKOFF</code></dt>
2911 <dd>Attempting to reconnect at an increasing period.</dd>
2913 <dt><code>CONNECTING</code></dt>
2914 <dd>Attempting to connect.</dd>
2916 <dt><code>ACTIVE</code></dt>
2917 <dd>Connected, remote host responsive.</dd>
2919 <dt><code>IDLE</code></dt>
2920 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2923 These values may change in the future. They are provided only for
2928 <column name="status" key="sec_since_connect"
2929 type='{"type": "integer", "minInteger": 0}'>
2930 The amount of time since this manager last successfully connected
2931 to the database (in seconds). Value is empty if manager has never
2932 successfully connected.
2935 <column name="status" key="sec_since_disconnect"
2936 type='{"type": "integer", "minInteger": 0}'>
2937 The amount of time since this manager last disconnected from the
2938 database (in seconds). Value is empty if manager has never
2942 <column name="status" key="locks_held">
2943 Space-separated list of the names of OVSDB locks that the connection
2944 holds. Omitted if the connection does not hold any locks.
2947 <column name="status" key="locks_waiting">
2948 Space-separated list of the names of OVSDB locks that the connection is
2949 currently waiting to acquire. Omitted if the connection is not waiting
2953 <column name="status" key="locks_lost">
2954 Space-separated list of the names of OVSDB locks that the connection
2955 has had stolen by another OVSDB client. Omitted if no locks have been
2956 stolen from this connection.
2959 <column name="status" key="n_connections"
2960 type='{"type": "integer", "minInteger": 2}'>
2962 When <ref column="target"/> specifies a connection method that
2963 listens for inbound connections (e.g. <code>ptcp:</code> or
2964 <code>pssl:</code>) and more than one connection is actually active,
2965 the value is the number of active connections. Otherwise, this
2966 key-value pair is omitted.
2969 When multiple connections are active, status columns and key-value
2970 pairs (other than this one) report the status of one arbitrarily
2976 <group title="Connection Parameters">
2978 Additional configuration for a connection between the manager
2979 and the Open vSwitch Database.
2982 <column name="other_config" key="dscp"
2983 type='{"type": "integer"}'>
2984 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2985 in the Type of Service (TOS) field in the IP header. DSCP provides a
2986 mechanism to classify the network traffic and provide Quality of
2987 Service (QoS) on IP networks.
2989 The DSCP value specified here is used when establishing the connection
2990 between the manager and the Open vSwitch. The connection must be
2991 reset for the new DSCP values to take effect. If no value is
2992 specified, a default value of 48 is chosen. Valid DSCP values must be
2993 in the range 0 to 63.
2997 <group title="Common Columns">
2998 The overall purpose of these columns is described under <code>Common
2999 Columns</code> at the beginning of this document.
3001 <column name="external_ids"/>
3002 <column name="other_config"/>
3006 <table name="NetFlow">
3007 A NetFlow target. NetFlow is a protocol that exports a number of
3008 details about terminating IP flows, such as the principals involved
3011 <column name="targets">
3012 NetFlow targets in the form
3013 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3014 must be specified numerically, not as a DNS name.
3017 <column name="engine_id">
3018 Engine ID to use in NetFlow messages. Defaults to datapath index
3022 <column name="engine_type">
3023 Engine type to use in NetFlow messages. Defaults to datapath
3024 index if not specified.
3027 <column name="active_timeout">
3028 The interval at which NetFlow records are sent for flows that are
3029 still active, in seconds. A value of <code>0</code> requests the
3030 default timeout (currently 600 seconds); a value of <code>-1</code>
3031 disables active timeouts.
3034 <column name="add_id_to_interface">
3035 <p>If this column's value is <code>false</code>, the ingress and egress
3036 interface fields of NetFlow flow records are derived from OpenFlow port
3037 numbers. When it is <code>true</code>, the 7 most significant bits of
3038 these fields will be replaced by the least significant 7 bits of the
3039 engine id. This is useful because many NetFlow collectors do not
3040 expect multiple switches to be sending messages from the same host, so
3041 they do not store the engine information which could be used to
3042 disambiguate the traffic.</p>
3043 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3046 <group title="Common Columns">
3047 The overall purpose of these columns is described under <code>Common
3048 Columns</code> at the beginning of this document.
3050 <column name="external_ids"/>
3055 SSL configuration for an Open_vSwitch.
3057 <column name="private_key">
3058 Name of a PEM file containing the private key used as the switch's
3059 identity for SSL connections to the controller.
3062 <column name="certificate">
3063 Name of a PEM file containing a certificate, signed by the
3064 certificate authority (CA) used by the controller and manager,
3065 that certifies the switch's private key, identifying a trustworthy
3069 <column name="ca_cert">
3070 Name of a PEM file containing the CA certificate used to verify
3071 that the switch is connected to a trustworthy controller.
3074 <column name="bootstrap_ca_cert">
3075 If set to <code>true</code>, then Open vSwitch will attempt to
3076 obtain the CA certificate from the controller on its first SSL
3077 connection and save it to the named PEM file. If it is successful,
3078 it will immediately drop the connection and reconnect, and from then
3079 on all SSL connections must be authenticated by a certificate signed
3080 by the CA certificate thus obtained. <em>This option exposes the
3081 SSL connection to a man-in-the-middle attack obtaining the initial
3082 CA certificate.</em> It may still be useful for bootstrapping.
3085 <group title="Common Columns">
3086 The overall purpose of these columns is described under <code>Common
3087 Columns</code> at the beginning of this document.
3089 <column name="external_ids"/>
3093 <table name="sFlow">
3094 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3097 <column name="agent">
3098 Name of the network device whose IP address should be reported as the
3099 ``agent address'' to collectors. If not specified, the agent device is
3100 figured from the first target address and the routing table. If the
3101 routing table does not contain a route to the target, the IP address
3102 defaults to the <ref table="Controller" column="local_ip"/> in the
3103 collector's <ref table="Controller"/>. If an agent IP address cannot be
3104 determined any of these ways, sFlow is disabled.
3107 <column name="header">
3108 Number of bytes of a sampled packet to send to the collector.
3109 If not specified, the default is 128 bytes.
3112 <column name="polling">
3113 Polling rate in seconds to send port statistics to the collector.
3114 If not specified, defaults to 30 seconds.
3117 <column name="sampling">
3118 Rate at which packets should be sampled and sent to the collector.
3119 If not specified, defaults to 400, which means one out of 400
3120 packets, on average, will be sent to the collector.
3123 <column name="targets">
3124 sFlow targets in the form
3125 <code><var>ip</var>:<var>port</var></code>.
3128 <group title="Common Columns">
3129 The overall purpose of these columns is described under <code>Common
3130 Columns</code> at the beginning of this document.
3132 <column name="external_ids"/>