1 <?xml version="1.0" encoding="utf-8"?>
2 <database title="Open vSwitch Configuration Database">
4 A database with this schema holds the configuration for one Open
5 vSwitch daemon. The top-level configuration for the daemon is the
6 <ref table="Open_vSwitch"/> table, which must have exactly one
7 record. Records in other tables are significant only when they
8 can be reached directly or indirectly from the <ref
9 table="Open_vSwitch"/> table. Records that are not reachable from
10 the <ref table="Open_vSwitch"/> table are automatically deleted
11 from the database, except for records in a few distinguished
15 <h2>Common Columns</h2>
18 Most tables contain two special columns, named <code>other_config</code>
19 and <code>external_ids</code>. These columns have the same form and
20 purpose each place that they appear, so we describe them here to save space
25 <dt><code>other_config</code>: map of string-string pairs</dt>
28 Key-value pairs for configuring rarely used features. Supported keys,
29 along with the forms taken by their values, are documented individually
33 A few tables do not have <code>other_config</code> columns because no
34 key-value pairs have yet been defined for them.
38 <dt><code>external_ids</code>: map of string-string pairs</dt>
40 Key-value pairs for use by external frameworks that integrate with Open
41 vSwitch, rather than by Open vSwitch itself. System integrators should
42 either use the Open vSwitch development mailing list to coordinate on
43 common key-value definitions, or choose key names that are likely to be
44 unique. In some cases, where key-value pairs have been defined that are
45 likely to be widely useful, they are documented individually for each
50 <table name="Open_vSwitch" title="Open vSwitch configuration.">
51 Configuration for an Open vSwitch daemon. There must be exactly
52 one record in the <ref table="Open_vSwitch"/> table.
54 <group title="Configuration">
55 <column name="bridges">
56 Set of bridges managed by the daemon.
60 SSL used globally by the daemon.
63 <column name="external_ids" key="system-id">
64 A unique identifier for the Open vSwitch's physical host.
65 The form of the identifier depends on the type of the host.
66 On a Citrix XenServer, this will likely be the same as
67 <ref column="external_ids" key="xs-system-uuid"/>.
70 <column name="external_ids" key="xs-system-uuid">
71 The Citrix XenServer universally unique identifier for the physical
72 host as displayed by <code>xe host-list</code>.
76 <group title="Status">
77 <column name="next_cfg">
78 Sequence number for client to increment. When a client modifies
79 any part of the database configuration and wishes to wait for
80 Open vSwitch to finish applying the changes, it may increment
84 <column name="cur_cfg">
85 Sequence number that Open vSwitch sets to the current value of
86 <ref column="next_cfg"/> after it finishes applying a set of
87 configuration changes.
90 <group title="Statistics">
92 The <code>statistics</code> column contains key-value pairs that
93 report statistics about a system running an Open vSwitch. These are
94 updated periodically (currently, every 5 seconds). Key-value pairs
95 that cannot be determined or that do not apply to a platform are
99 <column name="other_config" key="enable-statistics"
100 type='{"type": "boolean"}'>
101 Statistics are disabled by default to avoid overhead in the common
102 case when statistics gathering is not useful. Set this value to
103 <code>true</code> to enable populating the <ref column="statistics"/>
104 column or to <code>false</code> to explicitly disable it.
107 <column name="statistics" key="cpu"
108 type='{"type": "integer", "minInteger": 1}'>
110 Number of CPU processors, threads, or cores currently online and
111 available to the operating system on which Open vSwitch is running,
112 as an integer. This may be less than the number installed, if some
113 are not online or if they are not available to the operating
117 Open vSwitch userspace processes are not multithreaded, but the
118 Linux kernel-based datapath is.
122 <column name="statistics" key="load_average">
123 A comma-separated list of three floating-point numbers,
124 representing the system load average over the last 1, 5, and 15
125 minutes, respectively.
128 <column name="statistics" key="memory">
130 A comma-separated list of integers, each of which represents a
131 quantity of memory in kilobytes that describes the operating
132 system on which Open vSwitch is running. In respective order,
137 <li>Total amount of RAM allocated to the OS.</li>
138 <li>RAM allocated to the OS that is in use.</li>
139 <li>RAM that can be flushed out to disk or otherwise discarded
140 if that space is needed for another purpose. This number is
141 necessarily less than or equal to the previous value.</li>
142 <li>Total disk space allocated for swap.</li>
143 <li>Swap space currently in use.</li>
147 On Linux, all five values can be determined and are included. On
148 other operating systems, only the first two values can be
149 determined, so the list will only have two values.
153 <column name="statistics" key="process_NAME">
155 One such key-value pair, with <code>NAME</code> replaced by
156 a process name, will exist for each running Open vSwitch
157 daemon process, with <var>name</var> replaced by the
158 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
159 value is a comma-separated list of integers. The integers
160 represent the following, with memory measured in kilobytes
161 and durations in milliseconds:
165 <li>The process's virtual memory size.</li>
166 <li>The process's resident set size.</li>
167 <li>The amount of user and system CPU time consumed by the
169 <li>The number of times that the process has crashed and been
170 automatically restarted by the monitor.</li>
171 <li>The duration since the process was started.</li>
172 <li>The duration for which the process has been running.</li>
176 The interpretation of some of these values depends on whether the
177 process was started with the <option>--monitor</option>. If it
178 was not, then the crash count will always be 0 and the two
179 durations will always be the same. If <option>--monitor</option>
180 was given, then the crash count may be positive; if it is, the
181 latter duration is the amount of time since the most recent crash
186 There will be one key-value pair for each file in Open vSwitch's
187 ``run directory'' (usually <code>/var/run/openvswitch</code>)
188 whose name ends in <code>.pid</code>, whose contents are a
189 process ID, and which is locked by a running process. The
190 <var>name</var> is taken from the pidfile's name.
194 Currently Open vSwitch is only able to obtain all of the above
195 detail on Linux systems. On other systems, the same key-value
196 pairs will be present but the values will always be the empty
201 <column name="statistics" key="file_systems">
203 A space-separated list of information on local, writable file
204 systems. Each item in the list describes one file system and
205 consists in turn of a comma-separated list of the following:
209 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
210 Any spaces or commas in the mount point are replaced by
212 <li>Total size, in kilobytes, as an integer.</li>
213 <li>Amount of storage in use, in kilobytes, as an integer.</li>
217 This key-value pair is omitted if there are no local, writable
218 file systems or if Open vSwitch cannot obtain the needed
225 <group title="Version Reporting">
227 These columns report the types and versions of the hardware and
228 software running Open vSwitch. We recommend in general that software
229 should test whether specific features are supported instead of relying
230 on version number checks. These values are primarily intended for
231 reporting to human administrators.
234 <column name="ovs_version">
235 The Open vSwitch version number, e.g. <code>1.1.0</code>.
238 <column name="db_version">
240 The database schema version number in the form
241 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
242 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
243 a non-backward compatible way (e.g. deleting a column or a table),
244 <var>major</var> is incremented. When the database schema is changed
245 in a backward compatible way (e.g. adding a new column),
246 <var>minor</var> is incremented. When the database schema is changed
247 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
252 The schema version is part of the database schema, so it can also be
253 retrieved by fetching the schema using the Open vSwitch database
258 <column name="system_type">
260 An identifier for the type of system on top of which Open vSwitch
261 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
264 System integrators are responsible for choosing and setting an
265 appropriate value for this column.
269 <column name="system_version">
271 The version of the system identified by <ref column="system_type"/>,
272 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
275 System integrators are responsible for choosing and setting an
276 appropriate value for this column.
282 <group title="Database Configuration">
284 These columns primarily configure the Open vSwitch database
285 (<code>ovsdb-server</code>), not the Open vSwitch switch
286 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
287 column="ssl"/> settings.
291 The Open vSwitch switch does read the database configuration to
292 determine remote IP addresses to which in-band control should apply.
295 <column name="manager_options">
296 Database clients to which the Open vSwitch database server should
297 connect or to which it should listen, along with options for how these
298 connection should be configured. See the <ref table="Manager"/> table
299 for more information.
303 <group title="Common Columns">
304 The overall purpose of these columns is described under <code>Common
305 Columns</code> at the beginning of this document.
307 <column name="other_config"/>
308 <column name="external_ids"/>
312 <table name="Bridge">
314 Configuration for a bridge within an
315 <ref table="Open_vSwitch"/>.
318 A <ref table="Bridge"/> record represents an Ethernet switch with one or
319 more ``ports,'' which are the <ref table="Port"/> records pointed to by
320 the <ref table="Bridge"/>'s <ref column="ports"/> column.
323 <group title="Core Features">
325 Bridge identifier. Should be alphanumeric and no more than about 8
326 bytes long. Must be unique among the names of ports, interfaces, and
330 <column name="ports">
331 Ports included in the bridge.
334 <column name="mirrors">
335 Port mirroring configuration.
338 <column name="netflow">
339 NetFlow configuration.
342 <column name="sflow">
346 <column name="flood_vlans">
348 VLAN IDs of VLANs on which MAC address learning should be disabled,
349 so that packets are flooded instead of being sent to specific ports
350 that are believed to contain packets' destination MACs. This should
351 ordinarily be used to disable MAC learning on VLANs used for
352 mirroring (RSPAN VLANs). It may also be useful for debugging.
355 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
356 the <ref table="Port"/> table) is incompatible with
357 <code>flood_vlans</code>. Consider using another bonding mode or
358 a different type of mirror instead.
363 <group title="OpenFlow Configuration">
364 <column name="controller">
366 OpenFlow controller set. If unset, then no OpenFlow controllers
371 If there are primary controllers, removing all of them clears the
372 flow table. If there are no primary controllers, adding one also
373 clears the flow table. Other changes to the set of controllers, such
374 as adding or removing a service controller, adding another primary
375 controller to supplement an existing primary controller, or removing
376 only one of two primary controllers, have no effect on the flow
381 <column name="flow_tables">
382 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
383 table ID to configuration for that table.
386 <column name="fail_mode">
387 <p>When a controller is configured, it is, ordinarily, responsible
388 for setting up all flows on the switch. Thus, if the connection to
389 the controller fails, no new network connections can be set up.
390 If the connection to the controller stays down long enough,
391 no packets can pass through the switch at all. This setting
392 determines the switch's response to such a situation. It may be set
393 to one of the following:
395 <dt><code>standalone</code></dt>
396 <dd>If no message is received from the controller for three
397 times the inactivity probe interval
398 (see <ref column="inactivity_probe"/>), then Open vSwitch
399 will take over responsibility for setting up flows. In
400 this mode, Open vSwitch causes the bridge to act like an
401 ordinary MAC-learning switch. Open vSwitch will continue
402 to retry connecting to the controller in the background
403 and, when the connection succeeds, it will discontinue its
404 standalone behavior.</dd>
405 <dt><code>secure</code></dt>
406 <dd>Open vSwitch will not set up flows on its own when the
407 controller connection fails or when no controllers are
408 defined. The bridge will continue to retry connecting to
409 any defined controllers forever.</dd>
413 The default is <code>standalone</code> if the value is unset, but
414 future versions of Open vSwitch may change the default.
417 The <code>standalone</code> mode can create forwarding loops on a
418 bridge that has more than one uplink port unless STP is enabled. To
419 avoid loops on such a bridge, configure <code>secure</code> mode or
420 enable STP (see <ref column="stp_enable"/>).
422 <p>When more than one controller is configured,
423 <ref column="fail_mode"/> is considered only when none of the
424 configured controllers can be contacted.</p>
426 Changing <ref column="fail_mode"/> when no primary controllers are
427 configured clears the flow table.
431 <column name="datapath_id">
432 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
433 (Setting this column has no useful effect. Set <ref
434 column="other-config" key="datapath-id"/> instead.)
437 <column name="other_config" key="datapath-id">
438 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
439 value. May not be all-zero.
442 <column name="other_config" key="dp-desc">
443 Human readable description of datapath. It it a maximum 256
444 byte-long free-form string to describe the datapath for
445 debugging purposes, e.g. <code>switch3 in room 3120</code>.
448 <column name="other_config" key="disable-in-band"
449 type='{"type": "boolean"}'>
450 If set to <code>true</code>, disable in-band control on the bridge
451 regardless of controller and manager settings.
454 <column name="other_config" key="in-band-queue"
455 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
456 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
457 that will be used by flows set up by in-band control on this bridge.
458 If unset, or if the port used by an in-band control flow does not have
459 QoS configured, or if the port does not have a queue with the specified
460 ID, the default queue is used instead.
463 <column name="protocols">
464 List of OpenFlow protocols that may be used when negotiating a
465 connection with a controller. A default value of
466 <code>OpenFlow10</code> will be used if this column is empty.
470 <group title="Spanning Tree Configuration">
471 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
472 that ensures loop-free topologies. It allows redundant links to
473 be included in the network to provide automatic backup paths if
474 the active links fails.
476 <column name="stp_enable">
477 Enable spanning tree on the bridge. By default, STP is disabled
478 on bridges. Bond, internal, and mirror ports are not supported
479 and will not participate in the spanning tree.
482 <column name="other_config" key="stp-system-id">
483 The bridge's STP identifier (the lower 48 bits of the bridge-id)
485 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
486 By default, the identifier is the MAC address of the bridge.
489 <column name="other_config" key="stp-priority"
490 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
491 The bridge's relative priority value for determining the root
492 bridge (the upper 16 bits of the bridge-id). A bridge with the
493 lowest bridge-id is elected the root. By default, the priority
497 <column name="other_config" key="stp-hello-time"
498 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
499 The interval between transmissions of hello messages by
500 designated ports, in seconds. By default the hello interval is
504 <column name="other_config" key="stp-max-age"
505 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
506 The maximum age of the information transmitted by the bridge
507 when it is the root bridge, in seconds. By default, the maximum
511 <column name="other_config" key="stp-forward-delay"
512 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
513 The delay to wait between transitioning root and designated
514 ports to <code>forwarding</code>, in seconds. By default, the
515 forwarding delay is 15 seconds.
519 <group title="Other Features">
520 <column name="datapath_type">
521 Name of datapath provider. The kernel datapath has
522 type <code>system</code>. The userspace datapath has
523 type <code>netdev</code>.
526 <column name="external_ids" key="bridge-id">
527 A unique identifier of the bridge. On Citrix XenServer this will
528 commonly be the same as
529 <ref column="external_ids" key="xs-network-uuids"/>.
532 <column name="external_ids" key="xs-network-uuids">
533 Semicolon-delimited set of universally unique identifier(s) for the
534 network with which this bridge is associated on a Citrix XenServer
535 host. The network identifiers are RFC 4122 UUIDs as displayed by,
536 e.g., <code>xe network-list</code>.
539 <column name="other_config" key="hwaddr">
540 An Ethernet address in the form
541 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
542 to set the hardware address of the local port and influence the
546 <column name="other_config" key="flow-eviction-threshold"
547 type='{"type": "integer", "minInteger": 0}'>
549 A number of flows as a nonnegative integer. This sets number of
550 flows at which eviction from the kernel flow table will be triggered.
551 If there are a large number of flows then increasing this value to
552 around the number of flows present can result in reduced CPU usage
556 The default is 1000. Values below 100 will be rounded up to 100.
560 <column name="other_config" key="forward-bpdu"
561 type='{"type": "boolean"}'>
562 Option to allow forwarding of BPDU frames when NORMAL action is
563 invoked. Frames with reserved Ethernet addresses (e.g. STP
564 BPDU) will be forwarded when this option is enabled and the
565 switch is not providing that functionality. If STP is enabled
566 on the port, STP BPDUs will never be forwarded. If the Open
567 vSwitch bridge is used to connect different Ethernet networks,
568 and if Open vSwitch node does not run STP, then this option
569 should be enabled. Default is disabled, set to
570 <code>true</code> to enable.
572 The following destination MAC addresss will not be forwarded when this
575 <dt><code>01:80:c2:00:00:00</code></dt>
576 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
578 <dt><code>01:80:c2:00:00:01</code></dt>
579 <dd>IEEE Pause frame.</dd>
581 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
582 <dd>Other reserved protocols.</dd>
584 <dt><code>00:e0:2b:00:00:00</code></dt>
585 <dd>Extreme Discovery Protocol (EDP).</dd>
588 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
590 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
592 <dt><code>01:00:0c:cc:cc:cc</code></dt>
594 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
595 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
599 <dt><code>01:00:0c:cc:cc:cd</code></dt>
600 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
602 <dt><code>01:00:0c:cd:cd:cd</code></dt>
603 <dd>Cisco STP Uplink Fast.</dd>
605 <dt><code>01:00:0c:00:00:00</code></dt>
606 <dd>Cisco Inter Switch Link.</dd>
608 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
613 <column name="other_config" key="mac-aging-time"
614 type='{"type": "integer", "minInteger": 1}'>
616 The maximum number of seconds to retain a MAC learning entry for
617 which no packets have been seen. The default is currently 300
618 seconds (5 minutes). The value, if specified, is forced into a
619 reasonable range, currently 15 to 3600 seconds.
623 A short MAC aging time allows a network to more quickly detect that a
624 host is no longer connected to a switch port. However, it also makes
625 it more likely that packets will be flooded unnecessarily, when they
626 are addressed to a connected host that rarely transmits packets. To
627 reduce the incidence of unnecessary flooding, use a MAC aging time
628 longer than the maximum interval at which a host will ordinarily
633 <column name="other_config" key="mac-table-size"
634 type='{"type": "integer", "minInteger": 1}'>
636 The maximum number of MAC addresses to learn. The default is
637 currently 2048. The value, if specified, is forced into a reasonable
638 range, currently 10 to 1,000,000.
643 <group title="Bridge Status">
645 Status information about bridges.
647 <column name="status">
648 Key-value pairs that report bridge status.
650 <column name="status" key="stp_bridge_id">
652 The bridge-id (in hex) used in spanning tree advertisements.
653 Configuring the bridge-id is described in the
654 <code>stp-system-id</code> and <code>stp-priority</code> keys
655 of the <code>other_config</code> section earlier.
658 <column name="status" key="stp_designated_root">
660 The designated root (in hex) for this spanning tree.
663 <column name="status" key="stp_root_path_cost">
665 The path cost of reaching the designated bridge. A lower
671 <group title="Common Columns">
672 The overall purpose of these columns is described under <code>Common
673 Columns</code> at the beginning of this document.
675 <column name="other_config"/>
676 <column name="external_ids"/>
680 <table name="Port" table="Port or bond configuration.">
681 <p>A port within a <ref table="Bridge"/>.</p>
682 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
683 <ref column="interfaces"/> column. Such a port logically
684 corresponds to a port on a physical Ethernet switch. A port
685 with more than one interface is a ``bonded port'' (see
686 <ref group="Bonding Configuration"/>).</p>
687 <p>Some properties that one might think as belonging to a port are actually
688 part of the port's <ref table="Interface"/> members.</p>
691 Port name. Should be alphanumeric and no more than about 8
692 bytes long. May be the same as the interface name, for
693 non-bonded ports. Must otherwise be unique among the names of
694 ports, interfaces, and bridges on a host.
697 <column name="interfaces">
698 The port's interfaces. If there is more than one, this is a
702 <group title="VLAN Configuration">
703 <p>Bridge ports support the following types of VLAN configuration:</p>
708 A trunk port carries packets on one or more specified VLANs
709 specified in the <ref column="trunks"/> column (often, on every
710 VLAN). A packet that ingresses on a trunk port is in the VLAN
711 specified in its 802.1Q header, or VLAN 0 if the packet has no
712 802.1Q header. A packet that egresses through a trunk port will
713 have an 802.1Q header if it has a nonzero VLAN ID.
717 Any packet that ingresses on a trunk port tagged with a VLAN that
718 the port does not trunk is dropped.
725 An access port carries packets on exactly one VLAN specified in the
726 <ref column="tag"/> column. Packets egressing on an access port
727 have no 802.1Q header.
731 Any packet with an 802.1Q header with a nonzero VLAN ID that
732 ingresses on an access port is dropped, regardless of whether the
733 VLAN ID in the header is the access port's VLAN ID.
737 <dt>native-tagged</dt>
739 A native-tagged port resembles a trunk port, with the exception that
740 a packet without an 802.1Q header that ingresses on a native-tagged
741 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
745 <dt>native-untagged</dt>
747 A native-untagged port resembles a native-tagged port, with the
748 exception that a packet that egresses on a native-untagged port in
749 the native VLAN will not have an 802.1Q header.
753 A packet will only egress through bridge ports that carry the VLAN of
754 the packet, as described by the rules above.
757 <column name="vlan_mode">
759 The VLAN mode of the port, as described above. When this column is
760 empty, a default mode is selected as follows:
764 If <ref column="tag"/> contains a value, the port is an access
765 port. The <ref column="trunks"/> column should be empty.
768 Otherwise, the port is a trunk port. The <ref column="trunks"/>
769 column value is honored if it is present.
776 For an access port, the port's implicitly tagged VLAN. For a
777 native-tagged or native-untagged port, the port's native VLAN. Must
778 be empty if this is a trunk port.
782 <column name="trunks">
784 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
785 or VLANs that this port trunks; if it is empty, then the port trunks
786 all VLANs. Must be empty if this is an access port.
789 A native-tagged or native-untagged port always trunks its native
790 VLAN, regardless of whether <ref column="trunks"/> includes that
795 <column name="other_config" key="priority-tags"
796 type='{"type": "boolean"}'>
798 An 802.1Q header contains two important pieces of information: a VLAN
799 ID and a priority. A frame with a zero VLAN ID, called a
800 ``priority-tagged'' frame, is supposed to be treated the same way as
801 a frame without an 802.1Q header at all (except for the priority).
805 However, some network elements ignore any frame that has 802.1Q
806 header at all, even when the VLAN ID is zero. Therefore, by default
807 Open vSwitch does not output priority-tagged frames, instead omitting
808 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
809 <code>true</code> to enable priority-tagged frames on a port.
813 Regardless of this setting, Open vSwitch omits the 802.1Q header on
814 output if both the VLAN ID and priority would be zero.
818 All frames output to native-tagged ports have a nonzero VLAN ID, so
819 this setting is not meaningful on native-tagged ports.
824 <group title="Bonding Configuration">
825 <p>A port that has more than one interface is a ``bonded port.'' Bonding
826 allows for load balancing and fail-over.</p>
829 The following types of bonding will work with any kind of upstream
830 switch. On the upstream switch, do not configure the interfaces as a
835 <dt><code>balance-slb</code></dt>
837 Balances flows among slaves based on source MAC address and output
838 VLAN, with periodic rebalancing as traffic patterns change.
841 <dt><code>active-backup</code></dt>
843 Assigns all flows to one slave, failing over to a backup slave when
844 the active slave is disabled. This is the only bonding mode in which
845 interfaces may be plugged into different upstream switches.
850 The following modes require the upstream switch to support 802.3ad with
851 successful LACP negotiation:
855 <dt><code>balance-tcp</code></dt>
857 Balances flows among slaves based on L2, L3, and L4 protocol
858 information such as destination MAC address, IP address, and TCP
863 <p>These columns apply only to bonded ports. Their values are
864 otherwise ignored.</p>
866 <column name="bond_mode">
867 <p>The type of bonding used for a bonded port. Defaults to
868 <code>active-backup</code> if unset.
872 <column name="other_config" key="bond-hash-basis"
873 type='{"type": "integer"}'>
874 An integer hashed along with flows when choosing output slaves in load
875 balanced bonds. When changed, all flows will be assigned different
876 hash values possibly causing slave selection decisions to change. Does
877 not affect bonding modes which do not employ load balancing such as
878 <code>active-backup</code>.
881 <group title="Link Failure Detection">
883 An important part of link bonding is detecting that links are down so
884 that they may be disabled. These settings determine how Open vSwitch
885 detects link failure.
888 <column name="other_config" key="bond-detect-mode"
889 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
890 The means used to detect link failures. Defaults to
891 <code>carrier</code> which uses each interface's carrier to detect
892 failures. When set to <code>miimon</code>, will check for failures
893 by polling each interface's MII.
896 <column name="other_config" key="bond-miimon-interval"
897 type='{"type": "integer"}'>
898 The interval, in milliseconds, between successive attempts to poll
899 each interface's MII. Relevant only when <ref column="other_config"
900 key="bond-detect-mode"/> is <code>miimon</code>.
903 <column name="bond_updelay">
905 The number of milliseconds for which the link must stay up on an
906 interface before the interface is considered to be up. Specify
907 <code>0</code> to enable the interface immediately.
911 This setting is honored only when at least one bonded interface is
912 already enabled. When no interfaces are enabled, then the first
913 bond interface to come up is enabled immediately.
917 <column name="bond_downdelay">
918 The number of milliseconds for which the link must stay down on an
919 interface before the interface is considered to be down. Specify
920 <code>0</code> to disable the interface immediately.
924 <group title="LACP Configuration">
926 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
927 allows switches to automatically detect that they are connected by
928 multiple links and aggregate across those links. These settings
929 control LACP behavior.
933 Configures LACP on this port. LACP allows directly connected
934 switches to negotiate which links may be bonded. LACP may be enabled
935 on non-bonded ports for the benefit of any switches they may be
936 connected to. <code>active</code> ports are allowed to initiate LACP
937 negotiations. <code>passive</code> ports are allowed to participate
938 in LACP negotiations initiated by a remote switch, but not allowed to
939 initiate such negotiations themselves. If LACP is enabled on a port
940 whose partner switch does not support LACP, the bond will be
941 disabled. Defaults to <code>off</code> if unset.
944 <column name="other_config" key="lacp-system-id">
945 The LACP system ID of this <ref table="Port"/>. The system ID of a
946 LACP bond is used to identify itself to its partners. Must be a
947 nonzero MAC address. Defaults to the bridge Ethernet address if
951 <column name="other_config" key="lacp-system-priority"
952 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
953 The LACP system priority of this <ref table="Port"/>. In LACP
954 negotiations, link status decisions are made by the system with the
955 numerically lower priority.
958 <column name="other_config" key="lacp-time"
959 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
961 The LACP timing which should be used on this <ref table="Port"/>.
962 By default <code>slow</code> is used. When configured to be
963 <code>fast</code> LACP heartbeats are requested at a rate of once
964 per second causing connectivity problems to be detected more
965 quickly. In <code>slow</code> mode, heartbeats are requested at a
966 rate of once every 30 seconds.
971 <group title="Rebalancing Configuration">
973 These settings control behavior when a bond is in
974 <code>balance-slb</code> or <code>balance-tcp</code> mode.
977 <column name="other_config" key="bond-rebalance-interval"
978 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
979 For a load balanced bonded port, the number of milliseconds between
980 successive attempts to rebalance the bond, that is, to move flows
981 from one interface on the bond to another in an attempt to keep usage
982 of each interface roughly equal. If zero, load balancing is disabled
983 on the bond (link failure still cause flows to move). If
984 less than 1000ms, the rebalance interval will be 1000ms.
988 <column name="bond_fake_iface">
989 For a bonded port, whether to create a fake internal interface with the
990 name of the port. Use only for compatibility with legacy software that
995 <group title="Spanning Tree Configuration">
996 <column name="other_config" key="stp-enable"
997 type='{"type": "boolean"}'>
998 If spanning tree is enabled on the bridge, member ports are
999 enabled by default (with the exception of bond, internal, and
1000 mirror ports which do not work with STP). If this column's
1001 value is <code>false</code> spanning tree is disabled on the
1005 <column name="other_config" key="stp-port-num"
1006 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1007 The port number used for the lower 8 bits of the port-id. By
1008 default, the numbers will be assigned automatically. If any
1009 port's number is manually configured on a bridge, then they
1013 <column name="other_config" key="stp-port-priority"
1014 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1015 The port's relative priority value for determining the root
1016 port (the upper 8 bits of the port-id). A port with a lower
1017 port-id will be chosen as the root port. By default, the
1021 <column name="other_config" key="stp-path-cost"
1022 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1023 Spanning tree path cost for the port. A lower number indicates
1024 a faster link. By default, the cost is based on the maximum
1029 <group title="Other Features">
1031 Quality of Service configuration for this port.
1035 The MAC address to use for this port for the purpose of choosing the
1036 bridge's MAC address. This column does not necessarily reflect the
1037 port's actual MAC address, nor will setting it change the port's actual
1041 <column name="fake_bridge">
1042 Does this port represent a sub-bridge for its tagged VLAN within the
1043 Bridge? See ovs-vsctl(8) for more information.
1046 <column name="external_ids" key="fake-bridge-id-*">
1047 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1048 column) are defined by prefixing a <ref table="Bridge"/> <ref
1049 table="Bridge" column="external_ids"/> key with
1050 <code>fake-bridge-</code>,
1051 e.g. <code>fake-bridge-xs-network-uuids</code>.
1055 <group title="Port Status">
1057 Status information about ports attached to bridges.
1059 <column name="status">
1060 Key-value pairs that report port status.
1062 <column name="status" key="stp_port_id">
1064 The port-id (in hex) used in spanning tree advertisements for
1065 this port. Configuring the port-id is described in the
1066 <code>stp-port-num</code> and <code>stp-port-priority</code>
1067 keys of the <code>other_config</code> section earlier.
1070 <column name="status" key="stp_state"
1071 type='{"type": "string", "enum": ["set",
1072 ["disabled", "listening", "learning",
1073 "forwarding", "blocking"]]}'>
1075 STP state of the port.
1078 <column name="status" key="stp_sec_in_state"
1079 type='{"type": "integer", "minInteger": 0}'>
1081 The amount of time (in seconds) port has been in the current
1085 <column name="status" key="stp_role"
1086 type='{"type": "string", "enum": ["set",
1087 ["root", "designated", "alternate"]]}'>
1089 STP role of the port.
1094 <group title="Port Statistics">
1096 Key-value pairs that report port statistics.
1098 <group title="Statistics: STP transmit and receive counters">
1099 <column name="statistics" key="stp_tx_count">
1100 Number of STP BPDUs sent on this port by the spanning
1103 <column name="statistics" key="stp_rx_count">
1104 Number of STP BPDUs received on this port and accepted by the
1105 spanning tree library.
1107 <column name="statistics" key="stp_error_count">
1108 Number of bad STP BPDUs received on this port. Bad BPDUs
1109 include runt packets and those with an unexpected protocol ID.
1114 <group title="Common Columns">
1115 The overall purpose of these columns is described under <code>Common
1116 Columns</code> at the beginning of this document.
1118 <column name="other_config"/>
1119 <column name="external_ids"/>
1123 <table name="Interface" title="One physical network device in a Port.">
1124 An interface within a <ref table="Port"/>.
1126 <group title="Core Features">
1127 <column name="name">
1128 Interface name. Should be alphanumeric and no more than about 8 bytes
1129 long. May be the same as the port name, for non-bonded ports. Must
1130 otherwise be unique among the names of ports, interfaces, and bridges
1134 <column name="mac_in_use">
1135 The MAC address in use by this interface.
1139 <p>Ethernet address to set for this interface. If unset then the
1140 default MAC address is used:</p>
1142 <li>For the local interface, the default is the lowest-numbered MAC
1143 address among the other bridge ports, either the value of the
1144 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1145 if set, or its actual MAC (for bonded ports, the MAC of its slave
1146 whose name is first in alphabetical order). Internal ports and
1147 bridge ports that are used as port mirroring destinations (see the
1148 <ref table="Mirror"/> table) are ignored.</li>
1149 <li>For other internal interfaces, the default MAC is randomly
1151 <li>External interfaces typically have a MAC address associated with
1152 their hardware.</li>
1154 <p>Some interfaces may not have a software-controllable MAC
1158 <column name="ofport">
1159 <p>OpenFlow port number for this interface. Unlike most columns, this
1160 column's value should be set only by Open vSwitch itself. Other
1161 clients should set this column to an empty set (the default) when
1162 creating an <ref table="Interface"/>.</p>
1163 <p>Open vSwitch populates this column when the port number becomes
1164 known. If the interface is successfully added,
1165 <ref column="ofport"/> will be set to a number between 1 and 65535
1166 (generally either in the range 1 to 65279, inclusive, or 65534, the
1167 port number for the OpenFlow ``local port''). If the interface
1168 cannot be added then Open vSwitch sets this column
1170 <p>When <ref column="ofport_request"/> is not set, Open vSwitch picks
1171 an appropriate value for this column and then tries to keep the value
1172 constant across restarts.</p>
1175 <column name="ofport_request">
1176 <p>Requested OpenFlow port number for this interface. The port
1177 number must be between 1 and 65279, inclusive. Some datapaths
1178 cannot satisfy all requests for particular port numbers. When
1179 this column is empty or the request cannot be fulfilled, the
1180 system will choose a free port. The <ref column="ofport"/>
1181 column reports the assigned OpenFlow port number.</p>
1182 <p>The port number must be requested in the same transaction
1183 that creates the port.</p>
1187 <group title="System-Specific Details">
1188 <column name="type">
1190 The interface type, one of:
1194 <dt><code>system</code></dt>
1195 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1196 Sometimes referred to as ``external interfaces'' since they are
1197 generally connected to hardware external to that on which the Open
1198 vSwitch is running. The empty string is a synonym for
1199 <code>system</code>.</dd>
1201 <dt><code>internal</code></dt>
1202 <dd>A simulated network device that sends and receives traffic. An
1203 internal interface whose <ref column="name"/> is the same as its
1204 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1205 ``local interface.'' It does not make sense to bond an internal
1206 interface, so the terms ``port'' and ``interface'' are often used
1207 imprecisely for internal interfaces.</dd>
1209 <dt><code>tap</code></dt>
1210 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1212 <dt><code>gre</code></dt>
1214 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1218 <dt><code>ipsec_gre</code></dt>
1220 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1224 <dt><code>gre64</code></dt>
1226 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1227 of key, it uses GRE protocol sequence number field. This is non
1228 standard use of GRE protocol since OVS does not increment
1229 sequence number for every packet at time of encap as expected by
1230 standard GRE implementation. See <ref group="Tunnel Options"/>
1231 for information on configuring GRE tunnels.
1234 <dt><code>ipsec_gre64</code></dt>
1236 Same as IPSEC_GRE except 64 bit key.
1239 <dt><code>vxlan</code></dt>
1242 An Ethernet tunnel over the experimental, UDP-based VXLAN
1243 protocol described at
1244 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1245 VXLAN is currently supported only with the Linux kernel datapath
1246 with kernel version 2.6.26 or later.
1249 As an experimental protocol, VXLAN has no officially assigned UDP
1250 port. Open vSwitch currently uses UDP destination port 8472.
1251 The source port used for VXLAN traffic varies on a per-flow basis
1252 and is in the ephemeral port range.
1256 <dt><code>lisp</code></dt>
1258 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1259 Separation Protocol (RFC 6830). LISP is currently supported only
1260 with the Linux kernel datapath with kernel version 2.6.26 or later.
1263 <dt><code>patch</code></dt>
1265 A pair of virtual devices that act as a patch cable.
1268 <dt><code>null</code></dt>
1269 <dd>An ignored interface. Deprecated and slated for removal in
1275 <group title="Tunnel Options">
1277 These options apply to interfaces with <ref column="type"/> of
1278 <code>gre</code>, <code>ipsec_gre</code>, <code>gre64</code>,
1279 <code>ipsec_gre64</code>, <code>vxlan</code>, and <code>lisp</code>.
1283 Each tunnel must be uniquely identified by the combination of <ref
1284 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1285 column="options" key="local_ip"/>, and <ref column="options"
1286 key="in_key"/>. If two ports are defined that are the same except one
1287 has an optional identifier and the other does not, the more specific
1288 one is matched first. <ref column="options" key="in_key"/> is
1289 considered more specific than <ref column="options" key="local_ip"/> if
1290 a port defines one and another port defines the other.
1293 <column name="options" key="remote_ip">
1294 Required. The tunnel endpoint. Only unicast endpoints are supported.
1297 <column name="options" key="local_ip">
1298 Optional. The destination IP that received packets must match.
1299 Default is to match all addresses.
1302 <column name="options" key="in_key">
1303 <p>Optional. The key that received packets must contain, one of:</p>
1307 <code>0</code>. The tunnel receives packets with no key or with a
1308 key of 0. This is equivalent to specifying no <ref column="options"
1309 key="in_key"/> at all.
1312 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1313 (for GRE64) number. The tunnel receives only packets with the
1317 The word <code>flow</code>. The tunnel accepts packets with any
1318 key. The key will be placed in the <code>tun_id</code> field for
1319 matching in the flow table. The <code>ovs-ofctl</code> manual page
1320 contains additional information about matching fields in OpenFlow
1329 <column name="options" key="out_key">
1330 <p>Optional. The key to be set on outgoing packets, one of:</p>
1334 <code>0</code>. Packets sent through the tunnel will have no key.
1335 This is equivalent to specifying no <ref column="options"
1336 key="out_key"/> at all.
1339 A positive 24-bit (for VXLAN and LISP), 32-bit (for GRE) or 64-bit
1340 (for GRE64) number. Packets sent through the tunnel will have the
1344 The word <code>flow</code>. Packets sent through the tunnel will
1345 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1346 vendor extension (0 is used in the absence of an action). The
1347 <code>ovs-ofctl</code> manual page contains additional information
1348 about the Nicira OpenFlow vendor extensions.
1353 <column name="options" key="key">
1354 Optional. Shorthand to set <code>in_key</code> and
1355 <code>out_key</code> at the same time.
1358 <column name="options" key="tos">
1359 Optional. The value of the ToS bits to be set on the encapsulating
1360 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1361 zero. It may also be the word <code>inherit</code>, in which case
1362 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1363 (otherwise it will be 0). The ECN fields are always inherited.
1367 <column name="options" key="ttl">
1368 Optional. The TTL to be set on the encapsulating packet. It may also
1369 be the word <code>inherit</code>, in which case the TTL will be copied
1370 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1371 system default, typically 64). Default is the system default TTL.
1374 <column name="options" key="df_default"
1375 type='{"type": "boolean"}'>
1376 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1377 outer headers to allow path MTU discovery. Default is enabled; set
1378 to <code>false</code> to disable.
1381 <group title="Tunnel Options: gre and ipsec_gre only">
1383 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1387 <column name="options" key="csum" type='{"type": "boolean"}'>
1389 Optional. Compute GRE checksums on outgoing packets. Default is
1390 disabled, set to <code>true</code> to enable. Checksums present on
1391 incoming packets will be validated regardless of this setting.
1395 GRE checksums impose a significant performance penalty because they
1396 cover the entire packet. The encapsulated L3, L4, and L7 packet
1397 contents typically have their own checksums, so this additional
1398 checksum only adds value for the GRE and encapsulated L2 headers.
1402 This option is supported for <code>ipsec_gre</code>, but not useful
1403 because GRE checksums are weaker than, and redundant with, IPsec
1404 payload authentication.
1409 <group title="Tunnel Options: ipsec_gre only">
1411 Only <code>ipsec_gre</code> interfaces support these options.
1414 <column name="options" key="peer_cert">
1415 Required for certificate authentication. A string containing the
1416 peer's certificate in PEM format. Additionally the host's
1417 certificate must be specified with the <code>certificate</code>
1421 <column name="options" key="certificate">
1422 Required for certificate authentication. The name of a PEM file
1423 containing a certificate that will be presented to the peer during
1427 <column name="options" key="private_key">
1428 Optional for certificate authentication. The name of a PEM file
1429 containing the private key associated with <code>certificate</code>.
1430 If <code>certificate</code> contains the private key, this option may
1434 <column name="options" key="psk">
1435 Required for pre-shared key authentication. Specifies a pre-shared
1436 key for authentication that must be identical on both sides of the
1442 <group title="Patch Options">
1444 Only <code>patch</code> interfaces support these options.
1447 <column name="options" key="peer">
1448 The <ref column="name"/> of the <ref table="Interface"/> for the other
1449 side of the patch. The named <ref table="Interface"/>'s own
1450 <code>peer</code> option must specify this <ref table="Interface"/>'s
1451 name. That is, the two patch interfaces must have reversed <ref
1452 column="name"/> and <code>peer</code> values.
1456 <group title="Interface Status">
1458 Status information about interfaces attached to bridges, updated every
1459 5 seconds. Not all interfaces have all of these properties; virtual
1460 interfaces don't have a link speed, for example. Non-applicable
1461 columns will have empty values.
1463 <column name="admin_state">
1465 The administrative state of the physical network link.
1469 <column name="link_state">
1471 The observed state of the physical network link. This is ordinarily
1472 the link's carrier status. If the interface's <ref table="Port"/> is
1473 a bond configured for miimon monitoring, it is instead the network
1474 link's miimon status.
1478 <column name="link_resets">
1480 The number of times Open vSwitch has observed the
1481 <ref column="link_state"/> of this <ref table="Interface"/> change.
1485 <column name="link_speed">
1487 The negotiated speed of the physical network link.
1488 Valid values are positive integers greater than 0.
1492 <column name="duplex">
1494 The duplex mode of the physical network link.
1500 The MTU (maximum transmission unit); i.e. the largest
1501 amount of data that can fit into a single Ethernet frame.
1502 The standard Ethernet MTU is 1500 bytes. Some physical media
1503 and many kinds of virtual interfaces can be configured with
1507 This column will be empty for an interface that does not
1508 have an MTU as, for example, some kinds of tunnels do not.
1512 <column name="lacp_current">
1513 Boolean value indicating LACP status for this interface. If true, this
1514 interface has current LACP information about its LACP partner. This
1515 information may be used to monitor the health of interfaces in a LACP
1516 enabled port. This column will be empty if LACP is not enabled.
1519 <column name="status">
1520 Key-value pairs that report port status. Supported status values are
1521 <ref column="type"/>-dependent; some interfaces may not have a valid
1522 <ref column="status" key="driver_name"/>, for example.
1525 <column name="status" key="driver_name">
1526 The name of the device driver controlling the network adapter.
1529 <column name="status" key="driver_version">
1530 The version string of the device driver controlling the network
1534 <column name="status" key="firmware_version">
1535 The version string of the network adapter's firmware, if available.
1538 <column name="status" key="source_ip">
1539 The source IP address used for an IPv4 tunnel end-point, such as
1543 <column name="status" key="tunnel_egress_iface">
1544 Egress interface for tunnels. Currently only relevant for GRE tunnels
1545 On Linux systems, this column will show the name of the interface
1546 which is responsible for routing traffic destined for the configured
1547 <ref column="options" key="remote_ip"/>. This could be an internal
1548 interface such as a bridge port.
1551 <column name="status" key="tunnel_egress_iface_carrier"
1552 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1553 Whether carrier is detected on <ref column="status"
1554 key="tunnel_egress_iface"/>.
1558 <group title="Statistics">
1560 Key-value pairs that report interface statistics. The current
1561 implementation updates these counters periodically. Future
1562 implementations may update them when an interface is created, when they
1563 are queried (e.g. using an OVSDB <code>select</code> operation), and
1564 just before an interface is deleted due to virtual interface hot-unplug
1565 or VM shutdown, and perhaps at other times, but not on any regular
1569 These are the same statistics reported by OpenFlow in its <code>struct
1570 ofp_port_stats</code> structure. If an interface does not support a
1571 given statistic, then that pair is omitted.
1573 <group title="Statistics: Successful transmit and receive counters">
1574 <column name="statistics" key="rx_packets">
1575 Number of received packets.
1577 <column name="statistics" key="rx_bytes">
1578 Number of received bytes.
1580 <column name="statistics" key="tx_packets">
1581 Number of transmitted packets.
1583 <column name="statistics" key="tx_bytes">
1584 Number of transmitted bytes.
1587 <group title="Statistics: Receive errors">
1588 <column name="statistics" key="rx_dropped">
1589 Number of packets dropped by RX.
1591 <column name="statistics" key="rx_frame_err">
1592 Number of frame alignment errors.
1594 <column name="statistics" key="rx_over_err">
1595 Number of packets with RX overrun.
1597 <column name="statistics" key="rx_crc_err">
1598 Number of CRC errors.
1600 <column name="statistics" key="rx_errors">
1601 Total number of receive errors, greater than or equal to the sum of
1605 <group title="Statistics: Transmit errors">
1606 <column name="statistics" key="tx_dropped">
1607 Number of packets dropped by TX.
1609 <column name="statistics" key="collisions">
1610 Number of collisions.
1612 <column name="statistics" key="tx_errors">
1613 Total number of transmit errors, greater than or equal to the sum of
1619 <group title="Ingress Policing">
1621 These settings control ingress policing for packets received on this
1622 interface. On a physical interface, this limits the rate at which
1623 traffic is allowed into the system from the outside; on a virtual
1624 interface (one connected to a virtual machine), this limits the rate at
1625 which the VM is able to transmit.
1628 Policing is a simple form of quality-of-service that simply drops
1629 packets received in excess of the configured rate. Due to its
1630 simplicity, policing is usually less accurate and less effective than
1631 egress QoS (which is configured using the <ref table="QoS"/> and <ref
1632 table="Queue"/> tables).
1635 Policing is currently implemented only on Linux. The Linux
1636 implementation uses a simple ``token bucket'' approach:
1640 The size of the bucket corresponds to <ref
1641 column="ingress_policing_burst"/>. Initially the bucket is full.
1644 Whenever a packet is received, its size (converted to tokens) is
1645 compared to the number of tokens currently in the bucket. If the
1646 required number of tokens are available, they are removed and the
1647 packet is forwarded. Otherwise, the packet is dropped.
1650 Whenever it is not full, the bucket is refilled with tokens at the
1651 rate specified by <ref column="ingress_policing_rate"/>.
1655 Policing interacts badly with some network protocols, and especially
1656 with fragmented IP packets. Suppose that there is enough network
1657 activity to keep the bucket nearly empty all the time. Then this token
1658 bucket algorithm will forward a single packet every so often, with the
1659 period depending on packet size and on the configured rate. All of the
1660 fragments of an IP packets are normally transmitted back-to-back, as a
1661 group. In such a situation, therefore, only one of these fragments
1662 will be forwarded and the rest will be dropped. IP does not provide
1663 any way for the intended recipient to ask for only the remaining
1664 fragments. In such a case there are two likely possibilities for what
1665 will happen next: either all of the fragments will eventually be
1666 retransmitted (as TCP will do), in which case the same problem will
1667 recur, or the sender will not realize that its packet has been dropped
1668 and data will simply be lost (as some UDP-based protocols will do).
1669 Either way, it is possible that no forward progress will ever occur.
1671 <column name="ingress_policing_rate">
1673 Maximum rate for data received on this interface, in kbps. Data
1674 received faster than this rate is dropped. Set to <code>0</code>
1675 (the default) to disable policing.
1679 <column name="ingress_policing_burst">
1680 <p>Maximum burst size for data received on this interface, in kb. The
1681 default burst size if set to <code>0</code> is 1000 kb. This value
1682 has no effect if <ref column="ingress_policing_rate"/>
1683 is <code>0</code>.</p>
1685 Specifying a larger burst size lets the algorithm be more forgiving,
1686 which is important for protocols like TCP that react severely to
1687 dropped packets. The burst size should be at least the size of the
1688 interface's MTU. Specifying a value that is numerically at least as
1689 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
1690 closer to achieving the full rate.
1695 <group title="Connectivity Fault Management">
1697 802.1ag Connectivity Fault Management (CFM) allows a group of
1698 Maintenance Points (MPs) called a Maintenance Association (MA) to
1699 detect connectivity problems with each other. MPs within a MA should
1700 have complete and exclusive interconnectivity. This is verified by
1701 occasionally broadcasting Continuity Check Messages (CCMs) at a
1702 configurable transmission interval.
1706 According to the 802.1ag specification, each Maintenance Point should
1707 be configured out-of-band with a list of Remote Maintenance Points it
1708 should have connectivity to. Open vSwitch differs from the
1709 specification in this area. It simply assumes the link is faulted if
1710 no Remote Maintenance Points are reachable, and considers it not
1715 When operating over tunnels which have no <code>in_key</code>, or an
1716 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
1717 with a tunnel key of zero.
1720 <column name="cfm_mpid">
1721 A Maintenance Point ID (MPID) uniquely identifies each endpoint within
1722 a Maintenance Association. The MPID is used to identify this endpoint
1723 to other Maintenance Points in the MA. Each end of a link being
1724 monitored should have a different MPID. Must be configured to enable
1725 CFM on this <ref table="Interface"/>.
1728 <column name="cfm_fault">
1730 Indicates a connectivity fault triggered by an inability to receive
1731 heartbeats from any remote endpoint. When a fault is triggered on
1732 <ref table="Interface"/>s participating in bonds, they will be
1736 Faults can be triggered for several reasons. Most importantly they
1737 are triggered when no CCMs are received for a period of 3.5 times the
1738 transmission interval. Faults are also triggered when any CCMs
1739 indicate that a Remote Maintenance Point is not receiving CCMs but
1740 able to send them. Finally, a fault is triggered if a CCM is
1741 received which indicates unexpected configuration. Notably, this
1742 case arises when a CCM is received which advertises the local MPID.
1746 <column name="cfm_fault_status" key="recv">
1747 Indicates a CFM fault was triggered due to a lack of CCMs received on
1748 the <ref table="Interface"/>.
1751 <column name="cfm_fault_status" key="rdi">
1752 Indicates a CFM fault was triggered due to the reception of a CCM with
1753 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
1754 are not receiving CCMs themselves. This typically indicates a
1755 unidirectional connectivity failure.
1758 <column name="cfm_fault_status" key="maid">
1759 Indicates a CFM fault was triggered due to the reception of a CCM with
1760 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
1761 with an identification number in addition to the MPID called the MAID.
1762 Open vSwitch only supports receiving CCM broadcasts tagged with the
1763 MAID it uses internally.
1766 <column name="cfm_fault_status" key="loopback">
1767 Indicates a CFM fault was triggered due to the reception of a CCM
1768 advertising the same MPID configured in the <ref column="cfm_mpid"/>
1769 column of this <ref table="Interface"/>. This may indicate a loop in
1773 <column name="cfm_fault_status" key="overflow">
1774 Indicates a CFM fault was triggered because the CFM module received
1775 CCMs from more remote endpoints than it can keep track of.
1778 <column name="cfm_fault_status" key="override">
1779 Indicates a CFM fault was manually triggered by an administrator using
1780 an <code>ovs-appctl</code> command.
1783 <column name="cfm_fault_status" key="interval">
1784 Indicates a CFM fault was triggered due to the reception of a CCM
1785 frame having an invalid interval.
1788 <column name="cfm_remote_opstate">
1789 <p>When in extended mode, indicates the operational state of the
1790 remote endpoint as either <code>up</code> or <code>down</code>. See
1791 <ref column="other_config" key="cfm_opstate"/>.
1795 <column name="cfm_health">
1797 Indicates the health of the interface as a percentage of CCM frames
1798 received over 21 <ref column="other_config" key="cfm_interval"/>s.
1799 The health of an interface is undefined if it is communicating with
1800 more than one <ref column="cfm_remote_mpids"/>. It reduces if
1801 healthy heartbeats are not received at the expected rate, and
1802 gradually improves as healthy heartbeats are received at the desired
1803 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
1804 health of the interface is refreshed.
1807 As mentioned above, the faults can be triggered for several reasons.
1808 The link health will deteriorate even if heartbeats are received but
1809 they are reported to be unhealthy. An unhealthy heartbeat in this
1810 context is a heartbeat for which either some fault is set or is out
1811 of sequence. The interface health can be 100 only on receiving
1812 healthy heartbeats at the desired rate.
1816 <column name="cfm_remote_mpids">
1817 When CFM is properly configured, Open vSwitch will occasionally
1818 receive CCM broadcasts. These broadcasts contain the MPID of the
1819 sending Maintenance Point. The list of MPIDs from which this
1820 <ref table="Interface"/> is receiving broadcasts from is regularly
1821 collected and written to this column.
1824 <column name="other_config" key="cfm_interval"
1825 type='{"type": "integer"}'>
1827 The interval, in milliseconds, between transmissions of CFM
1828 heartbeats. Three missed heartbeat receptions indicate a
1833 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
1834 60,000, or 600,000 ms are supported. Other values will be rounded
1835 down to the nearest value on the list. Extended mode (see <ref
1836 column="other_config" key="cfm_extended"/>) supports any interval up
1837 to 65,535 ms. In either mode, the default is 1000 ms.
1840 <p>We do not recommend using intervals less than 100 ms.</p>
1843 <column name="other_config" key="cfm_extended"
1844 type='{"type": "boolean"}'>
1845 When <code>true</code>, the CFM module operates in extended mode. This
1846 causes it to use a nonstandard destination address to avoid conflicting
1847 with compliant implementations which may be running concurrently on the
1848 network. Furthermore, extended mode increases the accuracy of the
1849 <code>cfm_interval</code> configuration parameter by breaking wire
1850 compatibility with 802.1ag compliant implementations. Defaults to
1853 <column name="other_config" key="cfm_opstate"
1854 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
1855 When <code>down</code>, the CFM module marks all CCMs it generates as
1856 operationally down without triggering a fault. This allows remote
1857 maintenance points to choose not to forward traffic to the
1858 <ref table="Interface"/> on which this CFM module is running.
1859 Currently, in Open vSwitch, the opdown bit of CCMs affects
1860 <ref table="Interface"/>s participating in bonds, and the bundle
1861 OpenFlow action. This setting is ignored when CFM is not in extended
1862 mode. Defaults to <code>up</code>.
1865 <column name="other_config" key="cfm_ccm_vlan"
1866 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1867 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1868 with the given value. May be the string <code>random</code> in which
1869 case each CCM will be tagged with a different randomly generated VLAN.
1872 <column name="other_config" key="cfm_ccm_pcp"
1873 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
1874 When set, the CFM module will apply a VLAN tag to all CCMs it generates
1875 with the given PCP value, the VLAN ID of the tag is governed by the
1876 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
1877 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
1883 <group title="Bonding Configuration">
1884 <column name="other_config" key="lacp-port-id"
1885 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1886 The LACP port ID of this <ref table="Interface"/>. Port IDs are
1887 used in LACP negotiations to identify individual ports
1888 participating in a bond.
1891 <column name="other_config" key="lacp-port-priority"
1892 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1893 The LACP port priority of this <ref table="Interface"/>. In LACP
1894 negotiations <ref table="Interface"/>s with numerically lower
1895 priorities are preferred for aggregation.
1898 <column name="other_config" key="lacp-aggregation-key"
1899 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1900 The LACP aggregation key of this <ref table="Interface"/>. <ref
1901 table="Interface"/>s with different aggregation keys may not be active
1902 within a given <ref table="Port"/> at the same time.
1906 <group title="Virtual Machine Identifiers">
1908 These key-value pairs specifically apply to an interface that
1909 represents a virtual Ethernet interface connected to a virtual
1910 machine. These key-value pairs should not be present for other types
1911 of interfaces. Keys whose names end in <code>-uuid</code> have
1912 values that uniquely identify the entity in question. For a Citrix
1913 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
1914 Other hypervisors may use other formats.
1917 <column name="external_ids" key="attached-mac">
1918 The MAC address programmed into the ``virtual hardware'' for this
1919 interface, in the form
1920 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
1921 For Citrix XenServer, this is the value of the <code>MAC</code> field
1922 in the VIF record for this interface.
1925 <column name="external_ids" key="iface-id">
1926 A system-unique identifier for the interface. On XenServer, this will
1927 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
1930 <column name="external_ids" key="iface-status"
1931 type='{"type": "string",
1932 "enum": ["set", ["active", "inactive"]]}'>
1934 Hypervisors may sometimes have more than one interface associated
1935 with a given <ref column="external_ids" key="iface-id"/>, only one of
1936 which is actually in use at a given time. For example, in some
1937 circumstances XenServer has both a ``tap'' and a ``vif'' interface
1938 for a single <ref column="external_ids" key="iface-id"/>, but only
1939 uses one of them at a time. A hypervisor that behaves this way must
1940 mark the currently in use interface <code>active</code> and the
1941 others <code>inactive</code>. A hypervisor that never has more than
1942 one interface for a given <ref column="external_ids" key="iface-id"/>
1943 may mark that interface <code>active</code> or omit <ref
1944 column="external_ids" key="iface-status"/> entirely.
1948 During VM migration, a given <ref column="external_ids"
1949 key="iface-id"/> might transiently be marked <code>active</code> on
1950 two different hypervisors. That is, <code>active</code> means that
1951 this <ref column="external_ids" key="iface-id"/> is the active
1952 instance within a single hypervisor, not in a broader scope.
1953 There is one exception: some hypervisors support ``migration'' from a
1954 given hypervisor to itself (most often for test purposes). During
1955 such a ``migration,'' two instances of a single <ref
1956 column="external_ids" key="iface-id"/> might both be briefly marked
1957 <code>active</code> on a single hypervisor.
1961 <column name="external_ids" key="xs-vif-uuid">
1962 The virtual interface associated with this interface.
1965 <column name="external_ids" key="xs-network-uuid">
1966 The virtual network to which this interface is attached.
1969 <column name="external_ids" key="vm-id">
1970 The VM to which this interface belongs. On XenServer, this will be the
1971 same as <ref column="external_ids" key="xs-vm-uuid"/>.
1974 <column name="external_ids" key="xs-vm-uuid">
1975 The VM to which this interface belongs.
1979 <group title="VLAN Splinters">
1981 The ``VLAN splinters'' feature increases Open vSwitch compatibility
1982 with buggy network drivers in old versions of Linux that do not
1983 properly support VLANs when VLAN devices are not used, at some cost
1984 in memory and performance.
1988 When VLAN splinters are enabled on a particular interface, Open vSwitch
1989 creates a VLAN device for each in-use VLAN. For sending traffic tagged
1990 with a VLAN on the interface, it substitutes the VLAN device. Traffic
1991 received on the VLAN device is treated as if it had been received on
1992 the interface on the particular VLAN.
1996 VLAN splinters consider a VLAN to be in use if:
2001 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2002 table="Port"/> record.
2006 The VLAN is listed within the <ref table="Port" column="trunks"/>
2007 column of the <ref table="Port"/> record of an interface on which
2008 VLAN splinters are enabled.
2010 An empty <ref table="Port" column="trunks"/> does not influence the
2011 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2012 will exceed the current 1,024 port per datapath limit.
2016 An OpenFlow flow within any bridge matches the VLAN.
2021 The same set of in-use VLANs applies to every interface on which VLAN
2022 splinters are enabled. That is, the set is not chosen separately for
2023 each interface but selected once as the union of all in-use VLANs based
2028 It does not make sense to enable VLAN splinters on an interface for an
2029 access port, or on an interface that is not a physical port.
2033 VLAN splinters are deprecated. When broken device drivers are no
2034 longer in widespread use, we will delete this feature.
2037 <column name="other_config" key="enable-vlan-splinters"
2038 type='{"type": "boolean"}'>
2040 Set to <code>true</code> to enable VLAN splinters on this interface.
2041 Defaults to <code>false</code>.
2045 VLAN splinters increase kernel and userspace memory overhead, so do
2046 not use them unless they are needed.
2050 VLAN splinters do not support 802.1p priority tags. Received
2051 priorities will appear to be 0, regardless of their actual values,
2052 and priorities on transmitted packets will also be cleared to 0.
2057 <group title="Common Columns">
2058 The overall purpose of these columns is described under <code>Common
2059 Columns</code> at the beginning of this document.
2061 <column name="other_config"/>
2062 <column name="external_ids"/>
2066 <table name="Flow_Table" title="OpenFlow table configuration">
2067 <p>Configuration for a particular OpenFlow table.</p>
2069 <column name="name">
2070 The table's name. Set this column to change the name that controllers
2071 will receive when they request table statistics, e.g. <code>ovs-ofctl
2072 dump-tables</code>. The name does not affect switch behavior.
2075 <column name="flow_limit">
2076 If set, limits the number of flows that may be added to the table. Open
2077 vSwitch may limit the number of flows in a table for other reasons,
2078 e.g. due to hardware limitations or for resource availability or
2079 performance reasons.
2082 <column name="overflow_policy">
2084 Controls the switch's behavior when an OpenFlow flow table modification
2085 request would add flows in excess of <ref column="flow_limit"/>. The
2086 supported values are:
2090 <dt><code>refuse</code></dt>
2092 Refuse to add the flow or flows. This is also the default policy
2093 when <ref column="overflow_policy"/> is unset.
2096 <dt><code>evict</code></dt>
2098 Delete the flow that will expire soonest. See <ref column="groups"/>
2104 <column name="groups">
2106 When <ref column="overflow_policy"/> is <code>evict</code>, this
2107 controls how flows are chosen for eviction when the flow table would
2108 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2109 of NXM fields or sub-fields, each of which takes one of the forms
2110 <code><var>field</var>[]</code> or
2111 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2112 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2113 <code>nicira-ext.h</code> for a complete list of NXM field names.
2117 When a flow must be evicted due to overflow, the flow to evict is
2118 chosen through an approximation of the following algorithm:
2123 Divide the flows in the table into groups based on the values of the
2124 specified fields or subfields, so that all of the flows in a given
2125 group have the same values for those fields. If a flow does not
2126 specify a given field, that field's value is treated as 0.
2130 Consider the flows in the largest group, that is, the group that
2131 contains the greatest number of flows. If two or more groups all
2132 have the same largest number of flows, consider the flows in all of
2137 Among the flows under consideration, choose the flow that expires
2138 soonest for eviction.
2143 The eviction process only considers flows that have an idle timeout or
2144 a hard timeout. That is, eviction never deletes permanent flows.
2145 (Permanent flows do count against <ref column="flow_limit"/>.)
2149 Open vSwitch ignores any invalid or unknown field specifications.
2153 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2154 column has no effect.
2159 <table name="QoS" title="Quality of Service configuration">
2160 <p>Quality of Service (QoS) configuration for each Port that
2163 <column name="type">
2164 <p>The type of QoS to implement. The currently defined types are
2167 <dt><code>linux-htb</code></dt>
2169 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2170 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2171 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2172 for information on how this classifier works and how to configure it.
2176 <dt><code>linux-hfsc</code></dt>
2178 Linux "Hierarchical Fair Service Curve" classifier.
2179 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2180 information on how this classifier works.
2185 <column name="queues">
2186 <p>A map from queue numbers to <ref table="Queue"/> records. The
2187 supported range of queue numbers depend on <ref column="type"/>. The
2188 queue numbers are the same as the <code>queue_id</code> used in
2189 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2193 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2194 actions when no specific queue has been set. When no configuration for
2195 queue 0 is present, it is automatically configured as if a <ref
2196 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2197 and <ref table="Queue" column="other_config"/> columns had been
2199 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2200 this case. With some queuing disciplines, this dropped all packets
2201 destined for the default queue.)
2205 <group title="Configuration for linux-htb and linux-hfsc">
2207 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2208 the following key-value pair:
2211 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2212 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2213 specified, for physical interfaces, the default is the link rate. For
2214 other interfaces or if the link rate cannot be determined, the default
2215 is currently 100 Mbps.
2219 <group title="Common Columns">
2220 The overall purpose of these columns is described under <code>Common
2221 Columns</code> at the beginning of this document.
2223 <column name="other_config"/>
2224 <column name="external_ids"/>
2228 <table name="Queue" title="QoS output queue.">
2229 <p>A configuration for a port output queue, used in configuring Quality of
2230 Service (QoS) features. May be referenced by <ref column="queues"
2231 table="QoS"/> column in <ref table="QoS"/> table.</p>
2233 <column name="dscp">
2234 If set, Open vSwitch will mark all traffic egressing this
2235 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
2236 default <ref table="Queue"/> is only marked if it was explicitly selected
2237 as the <ref table="Queue"/> at the time the packet was output. If unset,
2238 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
2242 <group title="Configuration for linux-htb QoS">
2244 <ref table="QoS"/> <ref table="QoS" column="type"/>
2245 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
2246 It has the following key-value pairs defined.
2249 <column name="other_config" key="min-rate"
2250 type='{"type": "integer", "minInteger": 1}'>
2251 Minimum guaranteed bandwidth, in bit/s.
2254 <column name="other_config" key="max-rate"
2255 type='{"type": "integer", "minInteger": 1}'>
2256 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2257 queue's rate will not be allowed to exceed the specified value, even
2258 if excess bandwidth is available. If unspecified, defaults to no
2262 <column name="other_config" key="burst"
2263 type='{"type": "integer", "minInteger": 1}'>
2264 Burst size, in bits. This is the maximum amount of ``credits'' that a
2265 queue can accumulate while it is idle. Optional. Details of the
2266 <code>linux-htb</code> implementation require a minimum burst size, so
2267 a too-small <code>burst</code> will be silently ignored.
2270 <column name="other_config" key="priority"
2271 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
2272 A queue with a smaller <code>priority</code> will receive all the
2273 excess bandwidth that it can use before a queue with a larger value
2274 receives any. Specific priority values are unimportant; only relative
2275 ordering matters. Defaults to 0 if unspecified.
2279 <group title="Configuration for linux-hfsc QoS">
2281 <ref table="QoS"/> <ref table="QoS" column="type"/>
2282 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
2283 It has the following key-value pairs defined.
2286 <column name="other_config" key="min-rate"
2287 type='{"type": "integer", "minInteger": 1}'>
2288 Minimum guaranteed bandwidth, in bit/s.
2291 <column name="other_config" key="max-rate"
2292 type='{"type": "integer", "minInteger": 1}'>
2293 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
2294 queue's rate will not be allowed to exceed the specified value, even if
2295 excess bandwidth is available. If unspecified, defaults to no
2300 <group title="Common Columns">
2301 The overall purpose of these columns is described under <code>Common
2302 Columns</code> at the beginning of this document.
2304 <column name="other_config"/>
2305 <column name="external_ids"/>
2309 <table name="Mirror" title="Port mirroring.">
2310 <p>A port mirror within a <ref table="Bridge"/>.</p>
2311 <p>A port mirror configures a bridge to send selected frames to special
2312 ``mirrored'' ports, in addition to their normal destinations. Mirroring
2313 traffic may also be referred to as SPAN or RSPAN, depending on how
2314 the mirrored traffic is sent.</p>
2316 <column name="name">
2317 Arbitrary identifier for the <ref table="Mirror"/>.
2320 <group title="Selecting Packets for Mirroring">
2322 To be selected for mirroring, a given packet must enter or leave the
2323 bridge through a selected port and it must also be in one of the
2327 <column name="select_all">
2328 If true, every packet arriving or departing on any port is
2329 selected for mirroring.
2332 <column name="select_dst_port">
2333 Ports on which departing packets are selected for mirroring.
2336 <column name="select_src_port">
2337 Ports on which arriving packets are selected for mirroring.
2340 <column name="select_vlan">
2341 VLANs on which packets are selected for mirroring. An empty set
2342 selects packets on all VLANs.
2346 <group title="Mirroring Destination Configuration">
2348 These columns are mutually exclusive. Exactly one of them must be
2352 <column name="output_port">
2353 <p>Output port for selected packets, if nonempty.</p>
2354 <p>Specifying a port for mirror output reserves that port exclusively
2355 for mirroring. No frames other than those selected for mirroring
2357 will be forwarded to the port, and any frames received on the port
2358 will be discarded.</p>
2360 The output port may be any kind of port supported by Open vSwitch.
2361 It may be, for example, a physical port (sometimes called SPAN) or a
2366 <column name="output_vlan">
2367 <p>Output VLAN for selected packets, if nonempty.</p>
2368 <p>The frames will be sent out all ports that trunk
2369 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
2370 <ref column="output_vlan"/>. When a mirrored frame is sent out a
2371 trunk port, the frame's VLAN tag will be set to
2372 <ref column="output_vlan"/>, replacing any existing tag; when it is
2373 sent out an implicit VLAN port, the frame will not be tagged. This
2374 type of mirroring is sometimes called RSPAN.</p>
2376 See the documentation for
2377 <ref column="other_config" key="forward-bpdu"/> in the
2378 <ref table="Interface"/> table for a list of destination MAC
2379 addresses which will not be mirrored to a VLAN to avoid confusing
2380 switches that interpret the protocols that they represent.
2382 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
2383 contains unmanaged switches. Consider an unmanaged physical switch
2384 with two ports: port 1, connected to an end host, and port 2,
2385 connected to an Open vSwitch configured to mirror received packets
2386 into VLAN 123 on port 2. Suppose that the end host sends a packet on
2387 port 1 that the physical switch forwards to port 2. The Open vSwitch
2388 forwards this packet to its destination and then reflects it back on
2389 port 2 in VLAN 123. This reflected packet causes the unmanaged
2390 physical switch to replace the MAC learning table entry, which
2391 correctly pointed to port 1, with one that incorrectly points to port
2392 2. Afterward, the physical switch will direct packets destined for
2393 the end host to the Open vSwitch on port 2, instead of to the end
2394 host on port 1, disrupting connectivity. If mirroring to a VLAN is
2395 desired in this scenario, then the physical switch must be replaced
2396 by one that learns Ethernet addresses on a per-VLAN basis. In
2397 addition, learning should be disabled on the VLAN containing mirrored
2398 traffic. If this is not done then intermediate switches will learn
2399 the MAC address of each end host from the mirrored traffic. If
2400 packets being sent to that end host are also mirrored, then they will
2401 be dropped since the switch will attempt to send them out the input
2402 port. Disabling learning for the VLAN will cause the switch to
2403 correctly send the packet out all ports configured for that VLAN. If
2404 Open vSwitch is being used as an intermediate switch, learning can be
2405 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
2406 in the appropriate <ref table="Bridge"/> table or tables.</p>
2408 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
2409 VLAN and should generally be preferred.
2414 <group title="Statistics: Mirror counters">
2416 Key-value pairs that report mirror statistics.
2418 <column name="statistics" key="tx_packets">
2419 Number of packets transmitted through this mirror.
2421 <column name="statistics" key="tx_bytes">
2422 Number of bytes transmitted through this mirror.
2426 <group title="Common Columns">
2427 The overall purpose of these columns is described under <code>Common
2428 Columns</code> at the beginning of this document.
2430 <column name="external_ids"/>
2434 <table name="Controller" title="OpenFlow controller configuration.">
2435 <p>An OpenFlow controller.</p>
2438 Open vSwitch supports two kinds of OpenFlow controllers:
2442 <dt>Primary controllers</dt>
2445 This is the kind of controller envisioned by the OpenFlow 1.0
2446 specification. Usually, a primary controller implements a network
2447 policy by taking charge of the switch's flow table.
2451 Open vSwitch initiates and maintains persistent connections to
2452 primary controllers, retrying the connection each time it fails or
2453 drops. The <ref table="Bridge" column="fail_mode"/> column in the
2454 <ref table="Bridge"/> table applies to primary controllers.
2458 Open vSwitch permits a bridge to have any number of primary
2459 controllers. When multiple controllers are configured, Open
2460 vSwitch connects to all of them simultaneously. Because
2461 OpenFlow 1.0 does not specify how multiple controllers
2462 coordinate in interacting with a single switch, more than
2463 one primary controller should be specified only if the
2464 controllers are themselves designed to coordinate with each
2465 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
2466 vendor extension may be useful for this.)
2469 <dt>Service controllers</dt>
2472 These kinds of OpenFlow controller connections are intended for
2473 occasional support and maintenance use, e.g. with
2474 <code>ovs-ofctl</code>. Usually a service controller connects only
2475 briefly to inspect or modify some of a switch's state.
2479 Open vSwitch listens for incoming connections from service
2480 controllers. The service controllers initiate and, if necessary,
2481 maintain the connections from their end. The <ref table="Bridge"
2482 column="fail_mode"/> column in the <ref table="Bridge"/> table does
2483 not apply to service controllers.
2487 Open vSwitch supports configuring any number of service controllers.
2493 The <ref column="target"/> determines the type of controller.
2496 <group title="Core Features">
2497 <column name="target">
2498 <p>Connection method for controller.</p>
2500 The following connection methods are currently supported for primary
2504 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2506 <p>The specified SSL <var>port</var> (default: 6633) on the host at
2507 the given <var>ip</var>, which must be expressed as an IP address
2508 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2509 column in the <ref table="Open_vSwitch"/> table must point to a
2510 valid SSL configuration when this form is used.</p>
2511 <p>SSL support is an optional feature that is not always built as
2512 part of Open vSwitch.</p>
2514 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2515 <dd>The specified TCP <var>port</var> (default: 6633) on the host at
2516 the given <var>ip</var>, which must be expressed as an IP address
2517 (not a DNS name).</dd>
2520 The following connection methods are currently supported for service
2524 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2527 Listens for SSL connections on the specified TCP <var>port</var>
2528 (default: 6633). If <var>ip</var>, which must be expressed as an
2529 IP address (not a DNS name), is specified, then connections are
2530 restricted to the specified local IP address.
2533 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2534 table="Open_vSwitch"/> table must point to a valid SSL
2535 configuration when this form is used.
2537 <p>SSL support is an optional feature that is not always built as
2538 part of Open vSwitch.</p>
2540 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2542 Listens for connections on the specified TCP <var>port</var>
2543 (default: 6633). If <var>ip</var>, which must be expressed as an
2544 IP address (not a DNS name), is specified, then connections are
2545 restricted to the specified local IP address.
2548 <p>When multiple controllers are configured for a single bridge, the
2549 <ref column="target"/> values must be unique. Duplicate
2550 <ref column="target"/> values yield unspecified results.</p>
2553 <column name="connection_mode">
2554 <p>If it is specified, this setting must be one of the following
2555 strings that describes how Open vSwitch contacts this OpenFlow
2556 controller over the network:</p>
2559 <dt><code>in-band</code></dt>
2560 <dd>In this mode, this controller's OpenFlow traffic travels over the
2561 bridge associated with the controller. With this setting, Open
2562 vSwitch allows traffic to and from the controller regardless of the
2563 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
2564 would never be able to connect to the controller, because it did
2565 not have a flow to enable it.) This is the most common connection
2566 mode because it is not necessary to maintain two independent
2568 <dt><code>out-of-band</code></dt>
2569 <dd>In this mode, OpenFlow traffic uses a control network separate
2570 from the bridge associated with this controller, that is, the
2571 bridge does not use any of its own network devices to communicate
2572 with the controller. The control network must be configured
2573 separately, before or after <code>ovs-vswitchd</code> is started.
2577 <p>If not specified, the default is implementation-specific.</p>
2581 <group title="Controller Failure Detection and Handling">
2582 <column name="max_backoff">
2583 Maximum number of milliseconds to wait between connection attempts.
2584 Default is implementation-specific.
2587 <column name="inactivity_probe">
2588 Maximum number of milliseconds of idle time on connection to
2589 controller before sending an inactivity probe message. If Open
2590 vSwitch does not communicate with the controller for the specified
2591 number of seconds, it will send a probe. If a response is not
2592 received for the same additional amount of time, Open vSwitch
2593 assumes the connection has been broken and attempts to reconnect.
2594 Default is implementation-specific. A value of 0 disables
2599 <group title="Asynchronous Message Configuration">
2601 OpenFlow switches send certain messages to controllers spontanenously,
2602 that is, not in response to any request from the controller. These
2603 messages are called ``asynchronous messages.'' These columns allow
2604 asynchronous messages to be limited or disabled to ensure the best use
2605 of network resources.
2608 <column name="enable_async_messages">
2609 The OpenFlow protocol enables asynchronous messages at time of
2610 connection establishment, which means that a controller can receive
2611 asynchronous messages, potentially many of them, even if it turns them
2612 off immediately after connecting. Set this column to
2613 <code>false</code> to change Open vSwitch behavior to disable, by
2614 default, all asynchronous messages. The controller can use the
2615 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
2616 on any messages that it does want to receive, if any.
2619 <column name="controller_rate_limit">
2621 The maximum rate at which the switch will forward packets to the
2622 OpenFlow controller, in packets per second. This feature prevents a
2623 single bridge from overwhelming the controller. If not specified,
2624 the default is implementation-specific.
2628 In addition, when a high rate triggers rate-limiting, Open vSwitch
2629 queues controller packets for each port and transmits them to the
2630 controller at the configured rate. The <ref
2631 column="controller_burst_limit"/> value limits the number of queued
2632 packets. Ports on a bridge share the packet queue fairly.
2636 Open vSwitch maintains two such packet rate-limiters per bridge: one
2637 for packets sent up to the controller because they do not correspond
2638 to any flow, and the other for packets sent up to the controller by
2639 request through flow actions. When both rate-limiters are filled with
2640 packets, the actual rate that packets are sent to the controller is
2641 up to twice the specified rate.
2645 <column name="controller_burst_limit">
2646 In conjunction with <ref column="controller_rate_limit"/>,
2647 the maximum number of unused packet credits that the bridge will
2648 allow to accumulate, in packets. If not specified, the default
2649 is implementation-specific.
2653 <group title="Additional In-Band Configuration">
2654 <p>These values are considered only in in-band control mode (see
2655 <ref column="connection_mode"/>).</p>
2657 <p>When multiple controllers are configured on a single bridge, there
2658 should be only one set of unique values in these columns. If different
2659 values are set for these columns in different controllers, the effect
2662 <column name="local_ip">
2663 The IP address to configure on the local port,
2664 e.g. <code>192.168.0.123</code>. If this value is unset, then
2665 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
2669 <column name="local_netmask">
2670 The IP netmask to configure on the local port,
2671 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
2672 but this value is unset, then the default is chosen based on whether
2673 the IP address is class A, B, or C.
2676 <column name="local_gateway">
2677 The IP address of the gateway to configure on the local port, as a
2678 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
2679 this network has no gateway.
2683 <group title="Controller Status">
2684 <column name="is_connected">
2685 <code>true</code> if currently connected to this controller,
2686 <code>false</code> otherwise.
2690 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
2691 <p>The level of authority this controller has on the associated
2692 bridge. Possible values are:</p>
2694 <dt><code>other</code></dt>
2695 <dd>Allows the controller access to all OpenFlow features.</dd>
2696 <dt><code>master</code></dt>
2697 <dd>Equivalent to <code>other</code>, except that there may be at
2698 most one master controller at a time. When a controller configures
2699 itself as <code>master</code>, any existing master is demoted to
2700 the <code>slave</code>role.</dd>
2701 <dt><code>slave</code></dt>
2702 <dd>Allows the controller read-only access to OpenFlow features.
2703 Attempts to modify the flow table will be rejected with an
2704 error. Slave controllers do not receive OFPT_PACKET_IN or
2705 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
2710 <column name="status" key="last_error">
2711 A human-readable description of the last error on the connection
2712 to the controller; i.e. <code>strerror(errno)</code>. This key
2713 will exist only if an error has occurred.
2716 <column name="status" key="state"
2717 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2719 The state of the connection to the controller:
2722 <dt><code>VOID</code></dt>
2723 <dd>Connection is disabled.</dd>
2725 <dt><code>BACKOFF</code></dt>
2726 <dd>Attempting to reconnect at an increasing period.</dd>
2728 <dt><code>CONNECTING</code></dt>
2729 <dd>Attempting to connect.</dd>
2731 <dt><code>ACTIVE</code></dt>
2732 <dd>Connected, remote host responsive.</dd>
2734 <dt><code>IDLE</code></dt>
2735 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2738 These values may change in the future. They are provided only for
2743 <column name="status" key="sec_since_connect"
2744 type='{"type": "integer", "minInteger": 0}'>
2745 The amount of time since this controller last successfully connected to
2746 the switch (in seconds). Value is empty if controller has never
2747 successfully connected.
2750 <column name="status" key="sec_since_disconnect"
2751 type='{"type": "integer", "minInteger": 1}'>
2752 The amount of time since this controller last disconnected from
2753 the switch (in seconds). Value is empty if controller has never
2758 <group title="Connection Parameters">
2760 Additional configuration for a connection between the controller
2761 and the Open vSwitch.
2764 <column name="other_config" key="dscp"
2765 type='{"type": "integer"}'>
2766 The Differentiated Service Code Point (DSCP) is specified using 6 bits
2767 in the Type of Service (TOS) field in the IP header. DSCP provides a
2768 mechanism to classify the network traffic and provide Quality of
2769 Service (QoS) on IP networks.
2771 The DSCP value specified here is used when establishing the connection
2772 between the controller and the Open vSwitch. If no value is specified,
2773 a default value of 48 is chosen. Valid DSCP values must be in the
2779 <group title="Common Columns">
2780 The overall purpose of these columns is described under <code>Common
2781 Columns</code> at the beginning of this document.
2783 <column name="external_ids"/>
2784 <column name="other_config"/>
2788 <table name="Manager" title="OVSDB management connection.">
2790 Configuration for a database connection to an Open vSwitch database
2795 This table primarily configures the Open vSwitch database
2796 (<code>ovsdb-server</code>), not the Open vSwitch switch
2797 (<code>ovs-vswitchd</code>). The switch does read the table to determine
2798 what connections should be treated as in-band.
2802 The Open vSwitch database server can initiate and maintain active
2803 connections to remote clients. It can also listen for database
2807 <group title="Core Features">
2808 <column name="target">
2809 <p>Connection method for managers.</p>
2811 The following connection methods are currently supported:
2814 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2817 The specified SSL <var>port</var> (default: 6632) on the host at
2818 the given <var>ip</var>, which must be expressed as an IP address
2819 (not a DNS name). The <ref table="Open_vSwitch" column="ssl"/>
2820 column in the <ref table="Open_vSwitch"/> table must point to a
2821 valid SSL configuration when this form is used.
2824 SSL support is an optional feature that is not always built as
2825 part of Open vSwitch.
2829 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
2831 The specified TCP <var>port</var> (default: 6632) on the host at
2832 the given <var>ip</var>, which must be expressed as an IP address
2835 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2838 Listens for SSL connections on the specified TCP <var>port</var>
2839 (default: 6632). If <var>ip</var>, which must be expressed as an
2840 IP address (not a DNS name), is specified, then connections are
2841 restricted to the specified local IP address.
2844 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
2845 table="Open_vSwitch"/> table must point to a valid SSL
2846 configuration when this form is used.
2849 SSL support is an optional feature that is not always built as
2850 part of Open vSwitch.
2853 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
2855 Listens for connections on the specified TCP <var>port</var>
2856 (default: 6632). If <var>ip</var>, which must be expressed as an
2857 IP address (not a DNS name), is specified, then connections are
2858 restricted to the specified local IP address.
2861 <p>When multiple managers are configured, the <ref column="target"/>
2862 values must be unique. Duplicate <ref column="target"/> values yield
2863 unspecified results.</p>
2866 <column name="connection_mode">
2868 If it is specified, this setting must be one of the following strings
2869 that describes how Open vSwitch contacts this OVSDB client over the
2874 <dt><code>in-band</code></dt>
2876 In this mode, this connection's traffic travels over a bridge
2877 managed by Open vSwitch. With this setting, Open vSwitch allows
2878 traffic to and from the client regardless of the contents of the
2879 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
2880 to connect to the client, because it did not have a flow to enable
2881 it.) This is the most common connection mode because it is not
2882 necessary to maintain two independent networks.
2884 <dt><code>out-of-band</code></dt>
2886 In this mode, the client's traffic uses a control network separate
2887 from that managed by Open vSwitch, that is, Open vSwitch does not
2888 use any of its own network devices to communicate with the client.
2889 The control network must be configured separately, before or after
2890 <code>ovs-vswitchd</code> is started.
2895 If not specified, the default is implementation-specific.
2900 <group title="Client Failure Detection and Handling">
2901 <column name="max_backoff">
2902 Maximum number of milliseconds to wait between connection attempts.
2903 Default is implementation-specific.
2906 <column name="inactivity_probe">
2907 Maximum number of milliseconds of idle time on connection to the client
2908 before sending an inactivity probe message. If Open vSwitch does not
2909 communicate with the client for the specified number of seconds, it
2910 will send a probe. If a response is not received for the same
2911 additional amount of time, Open vSwitch assumes the connection has been
2912 broken and attempts to reconnect. Default is implementation-specific.
2913 A value of 0 disables inactivity probes.
2917 <group title="Status">
2918 <column name="is_connected">
2919 <code>true</code> if currently connected to this manager,
2920 <code>false</code> otherwise.
2923 <column name="status" key="last_error">
2924 A human-readable description of the last error on the connection
2925 to the manager; i.e. <code>strerror(errno)</code>. This key
2926 will exist only if an error has occurred.
2929 <column name="status" key="state"
2930 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
2932 The state of the connection to the manager:
2935 <dt><code>VOID</code></dt>
2936 <dd>Connection is disabled.</dd>
2938 <dt><code>BACKOFF</code></dt>
2939 <dd>Attempting to reconnect at an increasing period.</dd>
2941 <dt><code>CONNECTING</code></dt>
2942 <dd>Attempting to connect.</dd>
2944 <dt><code>ACTIVE</code></dt>
2945 <dd>Connected, remote host responsive.</dd>
2947 <dt><code>IDLE</code></dt>
2948 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
2951 These values may change in the future. They are provided only for
2956 <column name="status" key="sec_since_connect"
2957 type='{"type": "integer", "minInteger": 0}'>
2958 The amount of time since this manager last successfully connected
2959 to the database (in seconds). Value is empty if manager has never
2960 successfully connected.
2963 <column name="status" key="sec_since_disconnect"
2964 type='{"type": "integer", "minInteger": 0}'>
2965 The amount of time since this manager last disconnected from the
2966 database (in seconds). Value is empty if manager has never
2970 <column name="status" key="locks_held">
2971 Space-separated list of the names of OVSDB locks that the connection
2972 holds. Omitted if the connection does not hold any locks.
2975 <column name="status" key="locks_waiting">
2976 Space-separated list of the names of OVSDB locks that the connection is
2977 currently waiting to acquire. Omitted if the connection is not waiting
2981 <column name="status" key="locks_lost">
2982 Space-separated list of the names of OVSDB locks that the connection
2983 has had stolen by another OVSDB client. Omitted if no locks have been
2984 stolen from this connection.
2987 <column name="status" key="n_connections"
2988 type='{"type": "integer", "minInteger": 2}'>
2990 When <ref column="target"/> specifies a connection method that
2991 listens for inbound connections (e.g. <code>ptcp:</code> or
2992 <code>pssl:</code>) and more than one connection is actually active,
2993 the value is the number of active connections. Otherwise, this
2994 key-value pair is omitted.
2997 When multiple connections are active, status columns and key-value
2998 pairs (other than this one) report the status of one arbitrarily
3004 <group title="Connection Parameters">
3006 Additional configuration for a connection between the manager
3007 and the Open vSwitch Database.
3010 <column name="other_config" key="dscp"
3011 type='{"type": "integer"}'>
3012 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3013 in the Type of Service (TOS) field in the IP header. DSCP provides a
3014 mechanism to classify the network traffic and provide Quality of
3015 Service (QoS) on IP networks.
3017 The DSCP value specified here is used when establishing the connection
3018 between the manager and the Open vSwitch. If no value is specified, a
3019 default value of 48 is chosen. Valid DSCP values must be in the range
3024 <group title="Common Columns">
3025 The overall purpose of these columns is described under <code>Common
3026 Columns</code> at the beginning of this document.
3028 <column name="external_ids"/>
3029 <column name="other_config"/>
3033 <table name="NetFlow">
3034 A NetFlow target. NetFlow is a protocol that exports a number of
3035 details about terminating IP flows, such as the principals involved
3038 <column name="targets">
3039 NetFlow targets in the form
3040 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3041 must be specified numerically, not as a DNS name.
3044 <column name="engine_id">
3045 Engine ID to use in NetFlow messages. Defaults to datapath index
3049 <column name="engine_type">
3050 Engine type to use in NetFlow messages. Defaults to datapath
3051 index if not specified.
3054 <column name="active_timeout">
3055 The interval at which NetFlow records are sent for flows that are
3056 still active, in seconds. A value of <code>0</code> requests the
3057 default timeout (currently 600 seconds); a value of <code>-1</code>
3058 disables active timeouts.
3061 <column name="add_id_to_interface">
3062 <p>If this column's value is <code>false</code>, the ingress and egress
3063 interface fields of NetFlow flow records are derived from OpenFlow port
3064 numbers. When it is <code>true</code>, the 7 most significant bits of
3065 these fields will be replaced by the least significant 7 bits of the
3066 engine id. This is useful because many NetFlow collectors do not
3067 expect multiple switches to be sending messages from the same host, so
3068 they do not store the engine information which could be used to
3069 disambiguate the traffic.</p>
3070 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3073 <group title="Common Columns">
3074 The overall purpose of these columns is described under <code>Common
3075 Columns</code> at the beginning of this document.
3077 <column name="external_ids"/>
3082 SSL configuration for an Open_vSwitch.
3084 <column name="private_key">
3085 Name of a PEM file containing the private key used as the switch's
3086 identity for SSL connections to the controller.
3089 <column name="certificate">
3090 Name of a PEM file containing a certificate, signed by the
3091 certificate authority (CA) used by the controller and manager,
3092 that certifies the switch's private key, identifying a trustworthy
3096 <column name="ca_cert">
3097 Name of a PEM file containing the CA certificate used to verify
3098 that the switch is connected to a trustworthy controller.
3101 <column name="bootstrap_ca_cert">
3102 If set to <code>true</code>, then Open vSwitch will attempt to
3103 obtain the CA certificate from the controller on its first SSL
3104 connection and save it to the named PEM file. If it is successful,
3105 it will immediately drop the connection and reconnect, and from then
3106 on all SSL connections must be authenticated by a certificate signed
3107 by the CA certificate thus obtained. <em>This option exposes the
3108 SSL connection to a man-in-the-middle attack obtaining the initial
3109 CA certificate.</em> It may still be useful for bootstrapping.
3112 <group title="Common Columns">
3113 The overall purpose of these columns is described under <code>Common
3114 Columns</code> at the beginning of this document.
3116 <column name="external_ids"/>
3120 <table name="sFlow">
3121 <p>An sFlow(R) target. sFlow is a protocol for remote monitoring
3124 <column name="agent">
3125 Name of the network device whose IP address should be reported as the
3126 ``agent address'' to collectors. If not specified, the agent device is
3127 figured from the first target address and the routing table. If the
3128 routing table does not contain a route to the target, the IP address
3129 defaults to the <ref table="Controller" column="local_ip"/> in the
3130 collector's <ref table="Controller"/>. If an agent IP address cannot be
3131 determined any of these ways, sFlow is disabled.
3134 <column name="header">
3135 Number of bytes of a sampled packet to send to the collector.
3136 If not specified, the default is 128 bytes.
3139 <column name="polling">
3140 Polling rate in seconds to send port statistics to the collector.
3141 If not specified, defaults to 30 seconds.
3144 <column name="sampling">
3145 Rate at which packets should be sampled and sent to the collector.
3146 If not specified, defaults to 400, which means one out of 400
3147 packets, on average, will be sent to the collector.
3150 <column name="targets">
3151 sFlow targets in the form
3152 <code><var>ip</var>:<var>port</var></code>.
3155 <group title="Common Columns">
3156 The overall purpose of these columns is described under <code>Common
3157 Columns</code> at the beginning of this document.
3159 <column name="external_ids"/>