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>.
75 <column name="other_config" key="stats-update-interval"
76 type='{"type": "integer", "minInteger": 5000}'>
78 Interval for updating statistics to the database, in milliseconds.
79 This option will affect the update of the <code>statistics</code>
80 column in the following tables: <code>Port</code>, <code>Interface
81 </code>, <code>Mirror</code>.
84 Default value is 5000 ms.
87 Getting statistics more frequently can be achieved via OpenFlow.
91 <column name="other_config" key="flow-restore-wait"
92 type='{"type": "boolean"}'>
94 When <code>ovs-vswitchd</code> starts up, it has an empty flow table
95 and therefore it handles all arriving packets in its default fashion
96 according to its configuration, by dropping them or sending them to
97 an OpenFlow controller or switching them as a standalone switch.
98 This behavior is ordinarily desirable. However, if
99 <code>ovs-vswitchd</code> is restarting as part of a ``hot-upgrade,''
100 then this leads to a relatively long period during which packets are
104 This option allows for improvement. When <code>ovs-vswitchd</code>
105 starts with this value set as <code>true</code>, it will neither
106 flush or expire previously set datapath flows nor will it send and
107 receive any packets to or from the datapath. When this value is
108 later set to <code>false</code>, <code>ovs-vswitchd</code> will
109 start receiving packets from the datapath and re-setup the flows.
112 Thus, with this option, the procedure for a hot-upgrade of
113 <code>ovs-vswitchd</code> becomes roughly the following:
117 Stop <code>ovs-vswitchd</code>.
120 Set <ref column="other_config" key="flow-restore-wait"/>
121 to <code>true</code>.
124 Start <code>ovs-vswitchd</code>.
127 Use <code>ovs-ofctl</code> (or some other program, such as an
128 OpenFlow controller) to restore the OpenFlow flow table
129 to the desired state.
132 Set <ref column="other_config" key="flow-restore-wait"/>
133 to <code>false</code> (or remove it entirely from the database).
137 The <code>ovs-ctl</code>'s ``restart'' and ``force-reload-kmod''
138 functions use the above config option during hot upgrades.
142 <column name="other_config" key="flow-limit"
143 type='{"type": "integer", "minInteger": 0}'>
146 number of flows allowed in the datapath flow table. Internally OVS
147 will choose a flow limit which will likely be lower than this number,
148 based on real time network conditions.
151 The default is 200000.
155 <column name="other_config" key="n-dpdk-rxqs"
156 type='{"type": "integer", "minInteger": 1}'>
158 Specifies the number of rx queues to be created for each dpdk
159 interface. If not specified or specified to 0, one rx queue will
160 be created for each dpdk interface by default.
164 <column name="other_config" key="pmd-cpu-mask">
166 Specifies CPU mask for setting the cpu affinity of PMD (Poll
167 Mode Driver) threads. Value should be in the form of hex string,
168 similar to the dpdk EAL '-c COREMASK' option input or the 'taskset'
172 The lowest order bit corresponds to the first CPU core. A set bit
173 means the corresponding core is available and a pmd thread will be
174 created and pinned to it. If the input does not cover all cores,
175 those uncovered cores are considered not set.
178 If not specified, one pmd thread will be created for each numa node
179 and pinned to any available core on the numa node by default.
183 <column name="other_config" key="n-handler-threads"
184 type='{"type": "integer", "minInteger": 1}'>
186 Specifies the number of threads for software datapaths to use for
187 handling new flows. The default the number of online CPU cores minus
188 the number of revalidators.
191 This configuration is per datapath. If you have more than one
192 software datapath (e.g. some <code>system</code> bridges and some
193 <code>netdev</code> bridges), then the total number of threads is
194 <code>n-handler-threads</code> times the number of software
199 <column name="other_config" key="n-revalidator-threads"
200 type='{"type": "integer", "minInteger": 1}'>
202 Specifies the number of threads for software datapaths to use for
203 revalidating flows in the datapath. Typically, there is a direct
204 correlation between the number of revalidator threads, and the number
205 of flows allowed in the datapath. The default is the number of cpu
206 cores divided by four plus one. If <code>n-handler-threads</code> is
207 set, the default changes to the number of cpu cores minus the number
211 This configuration is per datapath. If you have more than one
212 software datapath (e.g. some <code>system</code> bridges and some
213 <code>netdev</code> bridges), then the total number of threads is
214 <code>n-handler-threads</code> times the number of software
220 <group title="Status">
221 <column name="next_cfg">
222 Sequence number for client to increment. When a client modifies
223 any part of the database configuration and wishes to wait for
224 Open vSwitch to finish applying the changes, it may increment
225 this sequence number.
228 <column name="cur_cfg">
229 Sequence number that Open vSwitch sets to the current value of
230 <ref column="next_cfg"/> after it finishes applying a set of
231 configuration changes.
234 <group title="Statistics">
236 The <code>statistics</code> column contains key-value pairs that
237 report statistics about a system running an Open vSwitch. These are
238 updated periodically (currently, every 5 seconds). Key-value pairs
239 that cannot be determined or that do not apply to a platform are
243 <column name="other_config" key="enable-statistics"
244 type='{"type": "boolean"}'>
245 Statistics are disabled by default to avoid overhead in the common
246 case when statistics gathering is not useful. Set this value to
247 <code>true</code> to enable populating the <ref column="statistics"/>
248 column or to <code>false</code> to explicitly disable it.
251 <column name="statistics" key="cpu"
252 type='{"type": "integer", "minInteger": 1}'>
254 Number of CPU processors, threads, or cores currently online and
255 available to the operating system on which Open vSwitch is running,
256 as an integer. This may be less than the number installed, if some
257 are not online or if they are not available to the operating
261 Open vSwitch userspace processes are not multithreaded, but the
262 Linux kernel-based datapath is.
266 <column name="statistics" key="load_average">
267 A comma-separated list of three floating-point numbers,
268 representing the system load average over the last 1, 5, and 15
269 minutes, respectively.
272 <column name="statistics" key="memory">
274 A comma-separated list of integers, each of which represents a
275 quantity of memory in kilobytes that describes the operating
276 system on which Open vSwitch is running. In respective order,
281 <li>Total amount of RAM allocated to the OS.</li>
282 <li>RAM allocated to the OS that is in use.</li>
283 <li>RAM that can be flushed out to disk or otherwise discarded
284 if that space is needed for another purpose. This number is
285 necessarily less than or equal to the previous value.</li>
286 <li>Total disk space allocated for swap.</li>
287 <li>Swap space currently in use.</li>
291 On Linux, all five values can be determined and are included. On
292 other operating systems, only the first two values can be
293 determined, so the list will only have two values.
297 <column name="statistics" key="process_NAME">
299 One such key-value pair, with <code>NAME</code> replaced by
300 a process name, will exist for each running Open vSwitch
301 daemon process, with <var>name</var> replaced by the
302 daemon's name (e.g. <code>process_ovs-vswitchd</code>). The
303 value is a comma-separated list of integers. The integers
304 represent the following, with memory measured in kilobytes
305 and durations in milliseconds:
309 <li>The process's virtual memory size.</li>
310 <li>The process's resident set size.</li>
311 <li>The amount of user and system CPU time consumed by the
313 <li>The number of times that the process has crashed and been
314 automatically restarted by the monitor.</li>
315 <li>The duration since the process was started.</li>
316 <li>The duration for which the process has been running.</li>
320 The interpretation of some of these values depends on whether the
321 process was started with the <option>--monitor</option>. If it
322 was not, then the crash count will always be 0 and the two
323 durations will always be the same. If <option>--monitor</option>
324 was given, then the crash count may be positive; if it is, the
325 latter duration is the amount of time since the most recent crash
330 There will be one key-value pair for each file in Open vSwitch's
331 ``run directory'' (usually <code>/var/run/openvswitch</code>)
332 whose name ends in <code>.pid</code>, whose contents are a
333 process ID, and which is locked by a running process. The
334 <var>name</var> is taken from the pidfile's name.
338 Currently Open vSwitch is only able to obtain all of the above
339 detail on Linux systems. On other systems, the same key-value
340 pairs will be present but the values will always be the empty
345 <column name="statistics" key="file_systems">
347 A space-separated list of information on local, writable file
348 systems. Each item in the list describes one file system and
349 consists in turn of a comma-separated list of the following:
353 <li>Mount point, e.g. <code>/</code> or <code>/var/log</code>.
354 Any spaces or commas in the mount point are replaced by
356 <li>Total size, in kilobytes, as an integer.</li>
357 <li>Amount of storage in use, in kilobytes, as an integer.</li>
361 This key-value pair is omitted if there are no local, writable
362 file systems or if Open vSwitch cannot obtain the needed
369 <group title="Version Reporting">
371 These columns report the types and versions of the hardware and
372 software running Open vSwitch. We recommend in general that software
373 should test whether specific features are supported instead of relying
374 on version number checks. These values are primarily intended for
375 reporting to human administrators.
378 <column name="ovs_version">
379 The Open vSwitch version number, e.g. <code>1.1.0</code>.
382 <column name="db_version">
384 The database schema version number in the form
385 <code><var>major</var>.<var>minor</var>.<var>tweak</var></code>,
386 e.g. <code>1.2.3</code>. Whenever the database schema is changed in
387 a non-backward compatible way (e.g. deleting a column or a table),
388 <var>major</var> is incremented. When the database schema is changed
389 in a backward compatible way (e.g. adding a new column),
390 <var>minor</var> is incremented. When the database schema is changed
391 cosmetically (e.g. reindenting its syntax), <var>tweak</var> is
396 The schema version is part of the database schema, so it can also be
397 retrieved by fetching the schema using the Open vSwitch database
402 <column name="system_type">
404 An identifier for the type of system on top of which Open vSwitch
405 runs, e.g. <code>XenServer</code> or <code>KVM</code>.
408 System integrators are responsible for choosing and setting an
409 appropriate value for this column.
413 <column name="system_version">
415 The version of the system identified by <ref column="system_type"/>,
416 e.g. <code>5.6.100-39265p</code> on XenServer 5.6.100 build 39265.
419 System integrators are responsible for choosing and setting an
420 appropriate value for this column.
426 <group title="Database Configuration">
428 These columns primarily configure the Open vSwitch database
429 (<code>ovsdb-server</code>), not the Open vSwitch switch
430 (<code>ovs-vswitchd</code>). The OVSDB database also uses the <ref
431 column="ssl"/> settings.
435 The Open vSwitch switch does read the database configuration to
436 determine remote IP addresses to which in-band control should apply.
439 <column name="manager_options">
440 Database clients to which the Open vSwitch database server should
441 connect or to which it should listen, along with options for how these
442 connection should be configured. See the <ref table="Manager"/> table
443 for more information.
447 <group title="Common Columns">
448 The overall purpose of these columns is described under <code>Common
449 Columns</code> at the beginning of this document.
451 <column name="other_config"/>
452 <column name="external_ids"/>
456 <table name="Bridge">
458 Configuration for a bridge within an
459 <ref table="Open_vSwitch"/>.
462 A <ref table="Bridge"/> record represents an Ethernet switch with one or
463 more ``ports,'' which are the <ref table="Port"/> records pointed to by
464 the <ref table="Bridge"/>'s <ref column="ports"/> column.
467 <group title="Core Features">
469 Bridge identifier. Should be alphanumeric and no more than about 8
470 bytes long. Must be unique among the names of ports, interfaces, and
474 <column name="ports">
475 Ports included in the bridge.
478 <column name="mirrors">
479 Port mirroring configuration.
482 <column name="netflow">
483 NetFlow configuration.
486 <column name="sflow">
487 sFlow(R) configuration.
490 <column name="ipfix">
494 <column name="flood_vlans">
496 VLAN IDs of VLANs on which MAC address learning should be disabled,
497 so that packets are flooded instead of being sent to specific ports
498 that are believed to contain packets' destination MACs. This should
499 ordinarily be used to disable MAC learning on VLANs used for
500 mirroring (RSPAN VLANs). It may also be useful for debugging.
503 SLB bonding (see the <ref table="Port" column="bond_mode"/> column in
504 the <ref table="Port"/> table) is incompatible with
505 <code>flood_vlans</code>. Consider using another bonding mode or
506 a different type of mirror instead.
511 <group title="OpenFlow Configuration">
512 <column name="controller">
514 OpenFlow controller set. If unset, then no OpenFlow controllers
519 If there are primary controllers, removing all of them clears the
520 flow table. If there are no primary controllers, adding one also
521 clears the flow table. Other changes to the set of controllers, such
522 as adding or removing a service controller, adding another primary
523 controller to supplement an existing primary controller, or removing
524 only one of two primary controllers, have no effect on the flow
529 <column name="flow_tables">
530 Configuration for OpenFlow tables. Each pair maps from an OpenFlow
531 table ID to configuration for that table.
534 <column name="fail_mode">
535 <p>When a controller is configured, it is, ordinarily, responsible
536 for setting up all flows on the switch. Thus, if the connection to
537 the controller fails, no new network connections can be set up.
538 If the connection to the controller stays down long enough,
539 no packets can pass through the switch at all. This setting
540 determines the switch's response to such a situation. It may be set
541 to one of the following:
543 <dt><code>standalone</code></dt>
544 <dd>If no message is received from the controller for three
545 times the inactivity probe interval
546 (see <ref column="inactivity_probe"/>), then Open vSwitch
547 will take over responsibility for setting up flows. In
548 this mode, Open vSwitch causes the bridge to act like an
549 ordinary MAC-learning switch. Open vSwitch will continue
550 to retry connecting to the controller in the background
551 and, when the connection succeeds, it will discontinue its
552 standalone behavior.</dd>
553 <dt><code>secure</code></dt>
554 <dd>Open vSwitch will not set up flows on its own when the
555 controller connection fails or when no controllers are
556 defined. The bridge will continue to retry connecting to
557 any defined controllers forever.</dd>
561 The default is <code>standalone</code> if the value is unset, but
562 future versions of Open vSwitch may change the default.
565 The <code>standalone</code> mode can create forwarding loops on a
566 bridge that has more than one uplink port unless STP is enabled. To
567 avoid loops on such a bridge, configure <code>secure</code> mode or
568 enable STP (see <ref column="stp_enable"/>).
570 <p>When more than one controller is configured,
571 <ref column="fail_mode"/> is considered only when none of the
572 configured controllers can be contacted.</p>
574 Changing <ref column="fail_mode"/> when no primary controllers are
575 configured clears the flow table.
579 <column name="datapath_id">
580 Reports the OpenFlow datapath ID in use. Exactly 16 hex digits.
581 (Setting this column has no useful effect. Set <ref
582 column="other-config" key="datapath-id"/> instead.)
585 <column name="other_config" key="datapath-id">
586 Exactly 16 hex digits to set the OpenFlow datapath ID to a specific
587 value. May not be all-zero.
590 <column name="other_config" key="dp-desc">
591 Human readable description of datapath. It it a maximum 256
592 byte-long free-form string to describe the datapath for
593 debugging purposes, e.g. <code>switch3 in room 3120</code>.
596 <column name="other_config" key="disable-in-band"
597 type='{"type": "boolean"}'>
598 If set to <code>true</code>, disable in-band control on the bridge
599 regardless of controller and manager settings.
602 <column name="other_config" key="in-band-queue"
603 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
604 A queue ID as a nonnegative integer. This sets the OpenFlow queue ID
605 that will be used by flows set up by in-band control on this bridge.
606 If unset, or if the port used by an in-band control flow does not have
607 QoS configured, or if the port does not have a queue with the specified
608 ID, the default queue is used instead.
611 <column name="protocols">
613 List of OpenFlow protocols that may be used when negotiating
614 a connection with a controller. OpenFlow 1.0, 1.1, 1.2, and
615 1.3 are enabled by default if this column is empty.
619 OpenFlow 1.4 is not enabled by default because its implementation is
624 OpenFlow 1.5 has the same risks as OpenFlow 1.4, but it is even more
625 experimental because the OpenFlow 1.5 specification is still under
626 development and thus subject to change. Pass
627 <code>--enable-of15</code> to <code>ovs-vswitchd</code> to allow
628 OpenFlow 1.5 to be enabled.
633 <group title="Spanning Tree Configuration">
634 The IEEE 802.1D Spanning Tree Protocol (STP) is a network protocol
635 that ensures loop-free topologies. It allows redundant links to
636 be included in the network to provide automatic backup paths if
637 the active links fails.
639 <column name="stp_enable" type='{"type": "boolean"}'>
640 Enable spanning tree on the bridge. By default, STP is disabled
641 on bridges. Bond, internal, and mirror ports are not supported
642 and will not participate in the spanning tree.
645 <column name="other_config" key="stp-system-id">
646 The bridge's STP identifier (the lower 48 bits of the bridge-id)
648 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
649 By default, the identifier is the MAC address of the bridge.
652 <column name="other_config" key="stp-priority"
653 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
654 The bridge's relative priority value for determining the root
655 bridge (the upper 16 bits of the bridge-id). A bridge with the
656 lowest bridge-id is elected the root. By default, the priority
660 <column name="other_config" key="stp-hello-time"
661 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
662 The interval between transmissions of hello messages by
663 designated ports, in seconds. By default the hello interval is
667 <column name="other_config" key="stp-max-age"
668 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
669 The maximum age of the information transmitted by the bridge
670 when it is the root bridge, in seconds. By default, the maximum
674 <column name="other_config" key="stp-forward-delay"
675 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
676 The delay to wait between transitioning root and designated
677 ports to <code>forwarding</code>, in seconds. By default, the
678 forwarding delay is 15 seconds.
681 <column name="other_config" key="mcast-snooping-aging-time"
682 type='{"type": "integer", "minInteger": 1}'>
684 The maximum number of seconds to retain a multicast snooping entry for
685 which no packets have been seen. The default is currently 300
686 seconds (5 minutes). The value, if specified, is forced into a
687 reasonable range, currently 15 to 3600 seconds.
691 <column name="other_config" key="mcast-snooping-table-size"
692 type='{"type": "integer", "minInteger": 1}'>
694 The maximum number of multicast snooping addresses to learn. The
695 default is currently 2048. The value, if specified, is forced into
696 a reasonable range, currently 10 to 1,000,000.
699 <column name="other_config" key="mcast-snooping-disable-flood-unregistered"
700 type='{"type": "boolean"}'>
702 If set to <code>false</code>, unregistered multicast packets are forwarded
704 If set to <code>true</code>, unregistered multicast packets are forwarded
705 to ports connected to multicast routers.
710 <group title="Multicast Snooping Configuration">
711 Multicast snooping (RFC 4541) monitors the Internet Group Management
712 Protocol (IGMP) traffic between hosts and multicast routers. The
713 switch uses what IGMP snooping learns to forward multicast traffic
714 only to interfaces that are connected to interested receivers.
715 Currently it supports IGMPv1 and IGMPv2 protocols.
717 <column name="mcast_snooping_enable">
718 Enable multicast snooping on the bridge. For now, the default
723 <group title="Rapid Spanning Tree Configuration">
724 In IEEE Std 802.1D, 1998 Edition, and prior editions of this standard,
725 Clause 8 specified the spanning tree algorithm and protocol (STP). STP
726 has now been superseded by the Rapid Spanning Tree Protocol (RSTP)
727 specified in Clause 17 of the IEEE Std 802.1D, 2004 Edition.
728 The IEEE 802.1D-2004 Rapid Spanning Tree Algorithm Protocol configures
729 full, simple, and symmetric connectivity throughout a Bridged Local Area
730 Network that comprises individual LANs interconnected by Bridges.
731 Like STP, RSTP is a network protocol that ensures loop-free topologies.
732 It allows redundant links to be included in the network to provide
733 automatic backup paths if the active links fails.
735 <column name="rstp_enable" type='{"type": "boolean"}'>
736 Enable Rapid Spanning Tree on the bridge. By default, RSTP is disabled
737 on bridges. Bond, internal, and mirror ports are not supported
738 and will not participate in the spanning tree.
741 <column name="other_config" key="rstp-address">
742 The bridge's RSTP address (the lower 48 bits of the bridge-id)
744 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
745 By default, the address is the MAC address of the bridge.
748 <column name="other_config" key="rstp-priority"
749 type='{"type": "integer", "minInteger": 0, "maxInteger": 61440}'>
750 The bridge's relative priority value for determining the root
751 bridge (the upper 16 bits of the bridge-id). A bridge with the
752 lowest bridge-id is elected the root. By default, the priority
753 is 0x8000 (32768). This value needs to be a multiple of 4096,
754 otherwise it's rounded to the nearest inferior one.
757 <column name="other_config" key="rstp-ageing-time"
758 type='{"type": "integer", "minInteger": 10, "maxInteger": 1000000}'>
759 The Ageing Time parameter for the Bridge. The default value
763 <column name="other_config" key="rstp-force-protocol-version"
764 type='{"type": "integer"}'>
765 The Force Protocol Version parameter for the Bridge. This
766 can take the value 0 (STP Compatibility mode) or 2
767 (the default, normal operation).
770 <column name="other_config" key="rstp-max-age"
771 type='{"type": "integer", "minInteger": 6, "maxInteger": 40}'>
772 The maximum age of the information transmitted by the Bridge
773 when it is the Root Bridge. The default value is 20.
776 <column name="other_config" key="rstp-forward-delay"
777 type='{"type": "integer", "minInteger": 4, "maxInteger": 30}'>
778 The delay used by STP Bridges to transition Root and Designated
779 Ports to Forwarding. The default value is 15.
782 <column name="other_config" key="rstp-transmit-hold-count"
783 type='{"type": "integer", "minInteger": 1, "maxInteger": 10}'>
784 The Transmit Hold Count used by the Port Transmit state machine
785 to limit transmission rate. The default value is 6.
790 <group title="Other Features">
791 <column name="datapath_type">
792 Name of datapath provider. The kernel datapath has
793 type <code>system</code>. The userspace datapath has
794 type <code>netdev</code>.
797 <column name="external_ids" key="bridge-id">
798 A unique identifier of the bridge. On Citrix XenServer this will
799 commonly be the same as
800 <ref column="external_ids" key="xs-network-uuids"/>.
803 <column name="external_ids" key="xs-network-uuids">
804 Semicolon-delimited set of universally unique identifier(s) for the
805 network with which this bridge is associated on a Citrix XenServer
806 host. The network identifiers are RFC 4122 UUIDs as displayed by,
807 e.g., <code>xe network-list</code>.
810 <column name="other_config" key="hwaddr">
811 An Ethernet address in the form
812 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
813 to set the hardware address of the local port and influence the
817 <column name="other_config" key="forward-bpdu"
818 type='{"type": "boolean"}'>
819 Option to allow forwarding of BPDU frames when NORMAL action is
820 invoked. Frames with reserved Ethernet addresses (e.g. STP
821 BPDU) will be forwarded when this option is enabled and the
822 switch is not providing that functionality. If STP is enabled
823 on the port, STP BPDUs will never be forwarded. If the Open
824 vSwitch bridge is used to connect different Ethernet networks,
825 and if Open vSwitch node does not run STP, then this option
826 should be enabled. Default is disabled, set to
827 <code>true</code> to enable.
829 The following destination MAC addresss will not be forwarded when this
832 <dt><code>01:80:c2:00:00:00</code></dt>
833 <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>
835 <dt><code>01:80:c2:00:00:01</code></dt>
836 <dd>IEEE Pause frame.</dd>
838 <dt><code>01:80:c2:00:00:0<var>x</var></code></dt>
839 <dd>Other reserved protocols.</dd>
841 <dt><code>00:e0:2b:00:00:00</code></dt>
842 <dd>Extreme Discovery Protocol (EDP).</dd>
845 <code>00:e0:2b:00:00:04</code> and <code>00:e0:2b:00:00:06</code>
847 <dd>Ethernet Automatic Protection Switching (EAPS).</dd>
849 <dt><code>01:00:0c:cc:cc:cc</code></dt>
851 Cisco Discovery Protocol (CDP), VLAN Trunking Protocol (VTP),
852 Dynamic Trunking Protocol (DTP), Port Aggregation Protocol (PAgP),
856 <dt><code>01:00:0c:cc:cc:cd</code></dt>
857 <dd>Cisco Shared Spanning Tree Protocol PVSTP+.</dd>
859 <dt><code>01:00:0c:cd:cd:cd</code></dt>
860 <dd>Cisco STP Uplink Fast.</dd>
862 <dt><code>01:00:0c:00:00:00</code></dt>
863 <dd>Cisco Inter Switch Link.</dd>
865 <dt><code>01:00:0c:cc:cc:c<var>x</var></code></dt>
870 <column name="other_config" key="mac-aging-time"
871 type='{"type": "integer", "minInteger": 1}'>
873 The maximum number of seconds to retain a MAC learning entry for
874 which no packets have been seen. The default is currently 300
875 seconds (5 minutes). The value, if specified, is forced into a
876 reasonable range, currently 15 to 3600 seconds.
880 A short MAC aging time allows a network to more quickly detect that a
881 host is no longer connected to a switch port. However, it also makes
882 it more likely that packets will be flooded unnecessarily, when they
883 are addressed to a connected host that rarely transmits packets. To
884 reduce the incidence of unnecessary flooding, use a MAC aging time
885 longer than the maximum interval at which a host will ordinarily
890 <column name="other_config" key="mac-table-size"
891 type='{"type": "integer", "minInteger": 1}'>
893 The maximum number of MAC addresses to learn. The default is
894 currently 2048. The value, if specified, is forced into a reasonable
895 range, currently 10 to 1,000,000.
900 <group title="Bridge Status">
902 Status information about bridges.
904 <column name="status">
905 Key-value pairs that report bridge status.
907 <column name="status" key="stp_bridge_id">
909 The bridge-id (in hex) used in spanning tree advertisements.
910 Configuring the bridge-id is described in the
911 <code>stp-system-id</code> and <code>stp-priority</code> keys
912 of the <code>other_config</code> section earlier.
915 <column name="status" key="stp_designated_root">
917 The designated root (in hex) for this spanning tree.
920 <column name="status" key="stp_root_path_cost">
922 The path cost of reaching the designated bridge. A lower
928 <group title="Common Columns">
929 The overall purpose of these columns is described under <code>Common
930 Columns</code> at the beginning of this document.
932 <column name="other_config"/>
933 <column name="external_ids"/>
937 <table name="Port" table="Port or bond configuration.">
938 <p>A port within a <ref table="Bridge"/>.</p>
939 <p>Most commonly, a port has exactly one ``interface,'' pointed to by its
940 <ref column="interfaces"/> column. Such a port logically
941 corresponds to a port on a physical Ethernet switch. A port
942 with more than one interface is a ``bonded port'' (see
943 <ref group="Bonding Configuration"/>).</p>
944 <p>Some properties that one might think as belonging to a port are actually
945 part of the port's <ref table="Interface"/> members.</p>
948 Port name. Should be alphanumeric and no more than about 8
949 bytes long. May be the same as the interface name, for
950 non-bonded ports. Must otherwise be unique among the names of
951 ports, interfaces, and bridges on a host.
954 <column name="interfaces">
955 The port's interfaces. If there is more than one, this is a
959 <group title="VLAN Configuration">
960 <p>Bridge ports support the following types of VLAN configuration:</p>
965 A trunk port carries packets on one or more specified VLANs
966 specified in the <ref column="trunks"/> column (often, on every
967 VLAN). A packet that ingresses on a trunk port is in the VLAN
968 specified in its 802.1Q header, or VLAN 0 if the packet has no
969 802.1Q header. A packet that egresses through a trunk port will
970 have an 802.1Q header if it has a nonzero VLAN ID.
974 Any packet that ingresses on a trunk port tagged with a VLAN that
975 the port does not trunk is dropped.
982 An access port carries packets on exactly one VLAN specified in the
983 <ref column="tag"/> column. Packets egressing on an access port
984 have no 802.1Q header.
988 Any packet with an 802.1Q header with a nonzero VLAN ID that
989 ingresses on an access port is dropped, regardless of whether the
990 VLAN ID in the header is the access port's VLAN ID.
994 <dt>native-tagged</dt>
996 A native-tagged port resembles a trunk port, with the exception that
997 a packet without an 802.1Q header that ingresses on a native-tagged
998 port is in the ``native VLAN'' (specified in the <ref column="tag"/>
1002 <dt>native-untagged</dt>
1004 A native-untagged port resembles a native-tagged port, with the
1005 exception that a packet that egresses on a native-untagged port in
1006 the native VLAN will not have an 802.1Q header.
1010 A packet will only egress through bridge ports that carry the VLAN of
1011 the packet, as described by the rules above.
1014 <column name="vlan_mode">
1016 The VLAN mode of the port, as described above. When this column is
1017 empty, a default mode is selected as follows:
1021 If <ref column="tag"/> contains a value, the port is an access
1022 port. The <ref column="trunks"/> column should be empty.
1025 Otherwise, the port is a trunk port. The <ref column="trunks"/>
1026 column value is honored if it is present.
1033 For an access port, the port's implicitly tagged VLAN. For a
1034 native-tagged or native-untagged port, the port's native VLAN. Must
1035 be empty if this is a trunk port.
1039 <column name="trunks">
1041 For a trunk, native-tagged, or native-untagged port, the 802.1Q VLAN
1042 or VLANs that this port trunks; if it is empty, then the port trunks
1043 all VLANs. Must be empty if this is an access port.
1046 A native-tagged or native-untagged port always trunks its native
1047 VLAN, regardless of whether <ref column="trunks"/> includes that
1052 <column name="other_config" key="priority-tags"
1053 type='{"type": "boolean"}'>
1055 An 802.1Q header contains two important pieces of information: a VLAN
1056 ID and a priority. A frame with a zero VLAN ID, called a
1057 ``priority-tagged'' frame, is supposed to be treated the same way as
1058 a frame without an 802.1Q header at all (except for the priority).
1062 However, some network elements ignore any frame that has 802.1Q
1063 header at all, even when the VLAN ID is zero. Therefore, by default
1064 Open vSwitch does not output priority-tagged frames, instead omitting
1065 the 802.1Q header entirely if the VLAN ID is zero. Set this key to
1066 <code>true</code> to enable priority-tagged frames on a port.
1070 Regardless of this setting, Open vSwitch omits the 802.1Q header on
1071 output if both the VLAN ID and priority would be zero.
1075 All frames output to native-tagged ports have a nonzero VLAN ID, so
1076 this setting is not meaningful on native-tagged ports.
1081 <group title="Bonding Configuration">
1082 <p>A port that has more than one interface is a ``bonded port.'' Bonding
1083 allows for load balancing and fail-over.</p>
1086 The following types of bonding will work with any kind of upstream
1087 switch. On the upstream switch, do not configure the interfaces as a
1092 <dt><code>balance-slb</code></dt>
1094 Balances flows among slaves based on source MAC address and output
1095 VLAN, with periodic rebalancing as traffic patterns change.
1098 <dt><code>active-backup</code></dt>
1100 Assigns all flows to one slave, failing over to a backup slave when
1101 the active slave is disabled. This is the only bonding mode in which
1102 interfaces may be plugged into different upstream switches.
1107 The following modes require the upstream switch to support 802.3ad with
1108 successful LACP negotiation. If LACP negotiation fails and
1109 other-config:lacp-fallback-ab is true, then <code>active-backup</code>
1114 <dt><code>balance-tcp</code></dt>
1116 Balances flows among slaves based on L2, L3, and L4 protocol
1117 information such as destination MAC address, IP address, and TCP
1122 <p>These columns apply only to bonded ports. Their values are
1123 otherwise ignored.</p>
1125 <column name="bond_mode">
1126 <p>The type of bonding used for a bonded port. Defaults to
1127 <code>active-backup</code> if unset.
1131 <column name="other_config" key="bond-hash-basis"
1132 type='{"type": "integer"}'>
1133 An integer hashed along with flows when choosing output slaves in load
1134 balanced bonds. When changed, all flows will be assigned different
1135 hash values possibly causing slave selection decisions to change. Does
1136 not affect bonding modes which do not employ load balancing such as
1137 <code>active-backup</code>.
1140 <group title="Link Failure Detection">
1142 An important part of link bonding is detecting that links are down so
1143 that they may be disabled. These settings determine how Open vSwitch
1144 detects link failure.
1147 <column name="other_config" key="bond-detect-mode"
1148 type='{"type": "string", "enum": ["set", ["carrier", "miimon"]]}'>
1149 The means used to detect link failures. Defaults to
1150 <code>carrier</code> which uses each interface's carrier to detect
1151 failures. When set to <code>miimon</code>, will check for failures
1152 by polling each interface's MII.
1155 <column name="other_config" key="bond-miimon-interval"
1156 type='{"type": "integer"}'>
1157 The interval, in milliseconds, between successive attempts to poll
1158 each interface's MII. Relevant only when <ref column="other_config"
1159 key="bond-detect-mode"/> is <code>miimon</code>.
1162 <column name="bond_updelay">
1164 The number of milliseconds for which the link must stay up on an
1165 interface before the interface is considered to be up. Specify
1166 <code>0</code> to enable the interface immediately.
1170 This setting is honored only when at least one bonded interface is
1171 already enabled. When no interfaces are enabled, then the first
1172 bond interface to come up is enabled immediately.
1176 <column name="bond_downdelay">
1177 The number of milliseconds for which the link must stay down on an
1178 interface before the interface is considered to be down. Specify
1179 <code>0</code> to disable the interface immediately.
1183 <group title="LACP Configuration">
1185 LACP, the Link Aggregation Control Protocol, is an IEEE standard that
1186 allows switches to automatically detect that they are connected by
1187 multiple links and aggregate across those links. These settings
1188 control LACP behavior.
1191 <column name="lacp">
1192 Configures LACP on this port. LACP allows directly connected
1193 switches to negotiate which links may be bonded. LACP may be enabled
1194 on non-bonded ports for the benefit of any switches they may be
1195 connected to. <code>active</code> ports are allowed to initiate LACP
1196 negotiations. <code>passive</code> ports are allowed to participate
1197 in LACP negotiations initiated by a remote switch, but not allowed to
1198 initiate such negotiations themselves. If LACP is enabled on a port
1199 whose partner switch does not support LACP, the bond will be
1200 disabled, unless other-config:lacp-fallback-ab is set to true.
1201 Defaults to <code>off</code> if unset.
1204 <column name="other_config" key="lacp-system-id">
1205 The LACP system ID of this <ref table="Port"/>. The system ID of a
1206 LACP bond is used to identify itself to its partners. Must be a
1207 nonzero MAC address. Defaults to the bridge Ethernet address if
1211 <column name="other_config" key="lacp-system-priority"
1212 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
1213 The LACP system priority of this <ref table="Port"/>. In LACP
1214 negotiations, link status decisions are made by the system with the
1215 numerically lower priority.
1218 <column name="other_config" key="lacp-time"
1219 type='{"type": "string", "enum": ["set", ["fast", "slow"]]}'>
1221 The LACP timing which should be used on this <ref table="Port"/>.
1222 By default <code>slow</code> is used. When configured to be
1223 <code>fast</code> LACP heartbeats are requested at a rate of once
1224 per second causing connectivity problems to be detected more
1225 quickly. In <code>slow</code> mode, heartbeats are requested at a
1226 rate of once every 30 seconds.
1230 <column name="other_config" key="lacp-fallback-ab"
1231 type='{"type": "boolean"}'>
1233 Determines the behavior of openvswitch bond in LACP mode. If
1234 the partner switch does not support LACP, setting this option
1235 to <code>true</code> allows openvswitch to fallback to
1236 active-backup. If the option is set to <code>false</code>, the
1237 bond will be disabled. In both the cases, once the partner switch
1238 is configured to LACP mode, the bond will use LACP.
1243 <group title="Rebalancing Configuration">
1245 These settings control behavior when a bond is in
1246 <code>balance-slb</code> or <code>balance-tcp</code> mode.
1249 <column name="other_config" key="bond-rebalance-interval"
1250 type='{"type": "integer", "minInteger": 0, "maxInteger": 10000}'>
1251 For a load balanced bonded port, the number of milliseconds between
1252 successive attempts to rebalance the bond, that is, to move flows
1253 from one interface on the bond to another in an attempt to keep usage
1254 of each interface roughly equal. If zero, load balancing is disabled
1255 on the bond (link failure still cause flows to move). If
1256 less than 1000ms, the rebalance interval will be 1000ms.
1260 <column name="bond_fake_iface">
1261 For a bonded port, whether to create a fake internal interface with the
1262 name of the port. Use only for compatibility with legacy software that
1267 <group title="Spanning Tree Configuration">
1268 <column name="other_config" key="stp-enable"
1269 type='{"type": "boolean"}'>
1270 If spanning tree is enabled on the bridge, member ports are
1271 enabled by default (with the exception of bond, internal, and
1272 mirror ports which do not work with STP). If this column's
1273 value is <code>false</code> spanning tree is disabled on the
1277 <column name="other_config" key="stp-port-num"
1278 type='{"type": "integer", "minInteger": 1, "maxInteger": 255}'>
1279 The port number used for the lower 8 bits of the port-id. By
1280 default, the numbers will be assigned automatically. If any
1281 port's number is manually configured on a bridge, then they
1285 <column name="other_config" key="stp-port-priority"
1286 type='{"type": "integer", "minInteger": 0, "maxInteger": 255}'>
1287 The port's relative priority value for determining the root
1288 port (the upper 8 bits of the port-id). A port with a lower
1289 port-id will be chosen as the root port. By default, the
1293 <column name="other_config" key="stp-path-cost"
1294 type='{"type": "integer", "minInteger": 0, "maxInteger": 65535}'>
1295 Spanning tree path cost for the port. A lower number indicates
1296 a faster link. By default, the cost is based on the maximum
1301 <group title="Rapid Spanning Tree Configuration">
1302 <column name="other_config" key="rstp-enable"
1303 type='{"type": "boolean"}'>
1304 If rapid spanning tree is enabled on the bridge, member ports are
1305 enabled by default (with the exception of bond, internal, and
1306 mirror ports which do not work with RSTP). If this column's
1307 value is <code>false</code> rapid spanning tree is disabled on the
1311 <column name="other_config" key="rstp-port-priority"
1312 type='{"type": "integer", "minInteger": 0, "maxInteger": 240}'>
1313 The port's relative priority value for determining the root
1314 port, in multiples of 16. By default, the port priority is 0x80
1315 (128). Any value in the lower 4 bits is rounded off. The significant
1316 upper 4 bits become the upper 4 bits of the port-id. A port with the
1317 lowest port-id is elected as the root.
1320 <column name="other_config" key="rstp-port-num"
1321 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
1322 The local RSTP port number, used as the lower 12 bits of the port-id.
1323 By default the port numbers are assigned automatically, and typically
1324 may not correspond to the OpenFlow port numbers. A port with the
1325 lowest port-id is elected as the root.
1328 <column name="other_config" key="rstp-port-path-cost"
1329 type='{"type": "integer"}'>
1330 The port path cost. The Port's contribution, when it is
1331 the Root Port, to the Root Path Cost for the Bridge. By default the
1332 cost is automatically calculated from the port's speed.
1335 <column name="other_config" key="rstp-port-admin-edge"
1336 type='{"type": "boolean"}'>
1337 The admin edge port parameter for the Port. Default is
1341 <column name="other_config" key="rstp-port-auto-edge"
1342 type='{"type": "boolean"}'>
1343 The auto edge port parameter for the Port. Default is
1347 <column name="other_config" key="rstp-port-mcheck"
1348 type='{"type": "boolean"}'>
1350 The mcheck port parameter for the Port. Default is
1351 <code>false</code>. May be set to force the Port Protocol
1352 Migration state machine to transmit RST BPDUs for a
1353 MigrateTime period, to test whether all STP Bridges on the
1354 attached LAN have been removed and the Port can continue to
1355 transmit RSTP BPDUs. Setting mcheck has no effect if the
1356 Bridge is operating in STP Compatibility mode.
1359 Changing the value from <code>true</code> to
1360 <code>false</code> has no effect, but needs to be done if
1361 this behavior is to be triggered again by subsequently
1362 changing the value from <code>false</code> to
1368 <group title="Multicast Snooping">
1369 <column name="other_config" key="mcast-snooping-flood"
1370 type='{"type": "boolean"}'>
1372 If set to <code>true</code>, multicast packets are unconditionally
1373 forwarded to the specific port.
1378 <group title="Other Features">
1380 Quality of Service configuration for this port.
1384 The MAC address to use for this port for the purpose of choosing the
1385 bridge's MAC address. This column does not necessarily reflect the
1386 port's actual MAC address, nor will setting it change the port's actual
1390 <column name="fake_bridge">
1391 Does this port represent a sub-bridge for its tagged VLAN within the
1392 Bridge? See ovs-vsctl(8) for more information.
1395 <column name="external_ids" key="fake-bridge-id-*">
1396 External IDs for a fake bridge (see the <ref column="fake_bridge"/>
1397 column) are defined by prefixing a <ref table="Bridge"/> <ref
1398 table="Bridge" column="external_ids"/> key with
1399 <code>fake-bridge-</code>,
1400 e.g. <code>fake-bridge-xs-network-uuids</code>.
1404 <group title="Port Status">
1406 Status information about ports attached to bridges.
1408 <column name="status">
1409 Key-value pairs that report port status.
1411 <column name="status" key="stp_port_id">
1413 The port-id (in hex) used in spanning tree advertisements for
1414 this port. Configuring the port-id is described in the
1415 <code>stp-port-num</code> and <code>stp-port-priority</code>
1416 keys of the <code>other_config</code> section earlier.
1419 <column name="status" key="stp_state"
1420 type='{"type": "string", "enum": ["set",
1421 ["disabled", "listening", "learning",
1422 "forwarding", "blocking"]]}'>
1424 STP state of the port.
1427 <column name="status" key="stp_sec_in_state"
1428 type='{"type": "integer", "minInteger": 0}'>
1430 The amount of time (in seconds) port has been in the current
1434 <column name="status" key="stp_role"
1435 type='{"type": "string", "enum": ["set",
1436 ["root", "designated", "alternate"]]}'>
1438 STP role of the port.
1442 <column name="status" key="bond_active_slave">
1444 For a bonded port, record the mac address of the current active slave.
1450 <group title="Port Statistics">
1452 Key-value pairs that report port statistics. The update period
1453 is controlled by <ref column="other_config"
1454 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
1456 <group title="Statistics: STP transmit and receive counters">
1457 <column name="statistics" key="stp_tx_count">
1458 Number of STP BPDUs sent on this port by the spanning
1461 <column name="statistics" key="stp_rx_count">
1462 Number of STP BPDUs received on this port and accepted by the
1463 spanning tree library.
1465 <column name="statistics" key="stp_error_count">
1466 Number of bad STP BPDUs received on this port. Bad BPDUs
1467 include runt packets and those with an unexpected protocol ID.
1472 <group title="Common Columns">
1473 The overall purpose of these columns is described under <code>Common
1474 Columns</code> at the beginning of this document.
1476 <column name="other_config"/>
1477 <column name="external_ids"/>
1481 <table name="Interface" title="One physical network device in a Port.">
1482 An interface within a <ref table="Port"/>.
1484 <group title="Core Features">
1485 <column name="name">
1486 Interface name. Should be alphanumeric and no more than about 8 bytes
1487 long. May be the same as the port name, for non-bonded ports. Must
1488 otherwise be unique among the names of ports, interfaces, and bridges
1492 <column name="ifindex">
1493 A positive interface index as defined for SNMP MIB-II in RFCs 1213 and
1494 2863, if the interface has one, otherwise 0. The ifindex is useful for
1495 seamless integration with protocols such as SNMP and sFlow.
1498 <column name="mac_in_use">
1499 The MAC address in use by this interface.
1503 <p>Ethernet address to set for this interface. If unset then the
1504 default MAC address is used:</p>
1506 <li>For the local interface, the default is the lowest-numbered MAC
1507 address among the other bridge ports, either the value of the
1508 <ref table="Port" column="mac"/> in its <ref table="Port"/> record,
1509 if set, or its actual MAC (for bonded ports, the MAC of its slave
1510 whose name is first in alphabetical order). Internal ports and
1511 bridge ports that are used as port mirroring destinations (see the
1512 <ref table="Mirror"/> table) are ignored.</li>
1513 <li>For other internal interfaces, the default MAC is randomly
1515 <li>External interfaces typically have a MAC address associated with
1516 their hardware.</li>
1518 <p>Some interfaces may not have a software-controllable MAC
1522 <column name="error">
1523 If the configuration of the port failed, as indicated by -1 in <ref
1524 column="ofport"/>, Open vSwitch sets this column to an error
1525 description in human readable form. Otherwise, Open vSwitch clears
1529 <group title="OpenFlow Port Number">
1531 When a client adds a new interface, Open vSwitch chooses an OpenFlow
1532 port number for the new port. If the client that adds the port fills
1533 in <ref column="ofport_request"/>, then Open vSwitch tries to use its
1534 value as the OpenFlow port number. Otherwise, or if the requested
1535 port number is already in use or cannot be used for another reason,
1536 Open vSwitch automatically assigns a free port number. Regardless of
1537 how the port number was obtained, Open vSwitch then reports in <ref
1538 column="ofport"/> the port number actually assigned.
1542 Open vSwitch limits the port numbers that it automatically assigns to
1543 the range 1 through 32,767, inclusive. Controllers therefore have
1544 free use of ports 32,768 and up.
1547 <column name="ofport">
1549 OpenFlow port number for this interface. Open vSwitch sets this
1550 column's value, so other clients should treat it as read-only.
1553 The OpenFlow ``local'' port (<code>OFPP_LOCAL</code>) is 65,534.
1554 The other valid port numbers are in the range 1 to 65,279,
1555 inclusive. Value -1 indicates an error adding the interface.
1559 <column name="ofport_request"
1560 type='{"type": "integer", "minInteger": 1, "maxInteger": 65279}'>
1562 Requested OpenFlow port number for this interface.
1566 A client should ideally set this column's value in the same
1567 database transaction that it uses to create the interface. Open
1568 vSwitch version 2.1 and later will honor a later request for a
1569 specific port number, althuogh it might confuse some controllers:
1570 OpenFlow does not have a way to announce a port number change, so
1571 Open vSwitch represents it over OpenFlow as a port deletion
1572 followed immediately by a port addition.
1576 If <ref column="ofport_request"/> is set or changed to some other
1577 port's automatically assigned port number, Open vSwitch chooses a
1578 new port number for the latter port.
1584 <group title="System-Specific Details">
1585 <column name="type">
1587 The interface type, one of:
1591 <dt><code>system</code></dt>
1592 <dd>An ordinary network device, e.g. <code>eth0</code> on Linux.
1593 Sometimes referred to as ``external interfaces'' since they are
1594 generally connected to hardware external to that on which the Open
1595 vSwitch is running. The empty string is a synonym for
1596 <code>system</code>.</dd>
1598 <dt><code>internal</code></dt>
1599 <dd>A simulated network device that sends and receives traffic. An
1600 internal interface whose <ref column="name"/> is the same as its
1601 bridge's <ref table="Open_vSwitch" column="name"/> is called the
1602 ``local interface.'' It does not make sense to bond an internal
1603 interface, so the terms ``port'' and ``interface'' are often used
1604 imprecisely for internal interfaces.</dd>
1606 <dt><code>tap</code></dt>
1607 <dd>A TUN/TAP device managed by Open vSwitch.</dd>
1609 <dt><code>geneve</code></dt>
1611 An Ethernet over Geneve (<code>http://tools.ietf.org/html/draft-gross-geneve-00</code>)
1614 Geneve supports options as a means to transport additional metadata,
1615 however, currently only the 24-bit VNI is supported. This is planned
1616 to be extended in the future.
1619 <dt><code>gre</code></dt>
1621 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1625 <dt><code>ipsec_gre</code></dt>
1627 An Ethernet over RFC 2890 Generic Routing Encapsulation over IPv4
1631 <dt><code>gre64</code></dt>
1633 It is same as GRE, but it allows 64 bit key. To store higher 32-bits
1634 of key, it uses GRE protocol sequence number field. This is non
1635 standard use of GRE protocol since OVS does not increment
1636 sequence number for every packet at time of encap as expected by
1637 standard GRE implementation. See <ref group="Tunnel Options"/>
1638 for information on configuring GRE tunnels.
1641 <dt><code>ipsec_gre64</code></dt>
1643 Same as IPSEC_GRE except 64 bit key.
1646 <dt><code>vxlan</code></dt>
1649 An Ethernet tunnel over the experimental, UDP-based VXLAN
1650 protocol described at
1651 <code>http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03</code>.
1654 Open vSwitch uses UDP destination port 4789. The source port used for
1655 VXLAN traffic varies on a per-flow basis and is in the ephemeral port
1660 <dt><code>lisp</code></dt>
1663 A layer 3 tunnel over the experimental, UDP-based Locator/ID
1664 Separation Protocol (RFC 6830).
1667 Only IPv4 and IPv6 packets are supported by the protocol, and
1668 they are sent and received without an Ethernet header. Traffic
1669 to/from LISP ports is expected to be configured explicitly, and
1670 the ports are not intended to participate in learning based
1671 switching. As such, they are always excluded from packet
1676 <dt><code>patch</code></dt>
1678 A pair of virtual devices that act as a patch cable.
1681 <dt><code>null</code></dt>
1682 <dd>An ignored interface. Deprecated and slated for removal in
1688 <group title="Tunnel Options">
1690 These options apply to interfaces with <ref column="type"/> of
1691 <code>geneve</code>, <code>gre</code>, <code>ipsec_gre</code>,
1692 <code>gre64</code>, <code>ipsec_gre64</code>, <code>vxlan</code>,
1693 and <code>lisp</code>.
1697 Each tunnel must be uniquely identified by the combination of <ref
1698 column="type"/>, <ref column="options" key="remote_ip"/>, <ref
1699 column="options" key="local_ip"/>, and <ref column="options"
1700 key="in_key"/>. If two ports are defined that are the same except one
1701 has an optional identifier and the other does not, the more specific
1702 one is matched first. <ref column="options" key="in_key"/> is
1703 considered more specific than <ref column="options" key="local_ip"/> if
1704 a port defines one and another port defines the other.
1707 <column name="options" key="remote_ip">
1708 <p>Required. The remote tunnel endpoint, one of:</p>
1712 An IPv4 address (not a DNS name), e.g. <code>192.168.0.123</code>.
1713 Only unicast endpoints are supported.
1716 The word <code>flow</code>. The tunnel accepts packets from any
1717 remote tunnel endpoint. To process only packets from a specific
1718 remote tunnel endpoint, the flow entries may match on the
1719 <code>tun_src</code> field. When sending packets to a
1720 <code>remote_ip=flow</code> tunnel, the flow actions must
1721 explicitly set the <code>tun_dst</code> field to the IP address of
1722 the desired remote tunnel endpoint, e.g. with a
1723 <code>set_field</code> action.
1728 The remote tunnel endpoint for any packet received from a tunnel
1729 is available in the <code>tun_src</code> field for matching in the
1734 <column name="options" key="local_ip">
1736 Optional. The tunnel destination IP that received packets must
1737 match. Default is to match all addresses. If specified, may be one
1743 An IPv4 address (not a DNS name), e.g. <code>192.168.12.3</code>.
1746 The word <code>flow</code>. The tunnel accepts packets sent to any
1747 of the local IP addresses of the system running OVS. To process
1748 only packets sent to a specific IP address, the flow entries may
1749 match on the <code>tun_dst</code> field. When sending packets to a
1750 <code>local_ip=flow</code> tunnel, the flow actions may
1751 explicitly set the <code>tun_src</code> field to the desired IP
1752 address, e.g. with a <code>set_field</code> action. However, while
1753 routing the tunneled packet out, the local system may override the
1754 specified address with the local IP address configured for the
1755 outgoing system interface.
1758 This option is valid only for tunnels also configured with the
1759 <code>remote_ip=flow</code> option.
1765 The tunnel destination IP address for any packet received from a
1766 tunnel is available in the <code>tun_dst</code> field for matching in
1771 <column name="options" key="in_key">
1772 <p>Optional. The key that received packets must contain, one of:</p>
1776 <code>0</code>. The tunnel receives packets with no key or with a
1777 key of 0. This is equivalent to specifying no <ref column="options"
1778 key="in_key"/> at all.
1781 A positive 24-bit (for Geneve, VXLAN, and LISP), 32-bit (for GRE)
1782 or 64-bit (for GRE64) number. The tunnel receives only packets
1783 with the specified key.
1786 The word <code>flow</code>. The tunnel accepts packets with any
1787 key. The key will be placed in the <code>tun_id</code> field for
1788 matching in the flow table. The <code>ovs-ofctl</code> manual page
1789 contains additional information about matching fields in OpenFlow
1798 <column name="options" key="out_key">
1799 <p>Optional. The key to be set on outgoing packets, one of:</p>
1803 <code>0</code>. Packets sent through the tunnel will have no key.
1804 This is equivalent to specifying no <ref column="options"
1805 key="out_key"/> at all.
1808 A positive 24-bit (for Geneve, VXLAN and LISP), 32-bit (for GRE) or
1809 64-bit (for GRE64) number. Packets sent through the tunnel will
1810 have the specified key.
1813 The word <code>flow</code>. Packets sent through the tunnel will
1814 have the key set using the <code>set_tunnel</code> Nicira OpenFlow
1815 vendor extension (0 is used in the absence of an action). The
1816 <code>ovs-ofctl</code> manual page contains additional information
1817 about the Nicira OpenFlow vendor extensions.
1822 <column name="options" key="key">
1823 Optional. Shorthand to set <code>in_key</code> and
1824 <code>out_key</code> at the same time.
1827 <column name="options" key="tos">
1828 Optional. The value of the ToS bits to be set on the encapsulating
1829 packet. ToS is interpreted as DSCP and ECN bits, ECN part must be
1830 zero. It may also be the word <code>inherit</code>, in which case
1831 the ToS will be copied from the inner packet if it is IPv4 or IPv6
1832 (otherwise it will be 0). The ECN fields are always inherited.
1836 <column name="options" key="ttl">
1837 Optional. The TTL to be set on the encapsulating packet. It may also
1838 be the word <code>inherit</code>, in which case the TTL will be copied
1839 from the inner packet if it is IPv4 or IPv6 (otherwise it will be the
1840 system default, typically 64). Default is the system default TTL.
1843 <column name="options" key="df_default"
1844 type='{"type": "boolean"}'>
1845 Optional. If enabled, the Don't Fragment bit will be set on tunnel
1846 outer headers to allow path MTU discovery. Default is enabled; set
1847 to <code>false</code> to disable.
1850 <group title="Tunnel Options: gre and ipsec_gre only">
1852 Only <code>gre</code> and <code>ipsec_gre</code> interfaces support
1856 <column name="options" key="csum" type='{"type": "boolean"}'>
1858 Optional. Compute GRE checksums on outgoing packets. Default is
1859 disabled, set to <code>true</code> to enable. Checksums present on
1860 incoming packets will be validated regardless of this setting.
1864 GRE checksums impose a significant performance penalty because they
1865 cover the entire packet. The encapsulated L3, L4, and L7 packet
1866 contents typically have their own checksums, so this additional
1867 checksum only adds value for the GRE and encapsulated L2 headers.
1871 This option is supported for <code>ipsec_gre</code>, but not useful
1872 because GRE checksums are weaker than, and redundant with, IPsec
1873 payload authentication.
1878 <group title="Tunnel Options: ipsec_gre only">
1880 Only <code>ipsec_gre</code> interfaces support these options.
1883 <column name="options" key="peer_cert">
1884 Required for certificate authentication. A string containing the
1885 peer's certificate in PEM format. Additionally the host's
1886 certificate must be specified with the <code>certificate</code>
1890 <column name="options" key="certificate">
1891 Required for certificate authentication. The name of a PEM file
1892 containing a certificate that will be presented to the peer during
1896 <column name="options" key="private_key">
1897 Optional for certificate authentication. The name of a PEM file
1898 containing the private key associated with <code>certificate</code>.
1899 If <code>certificate</code> contains the private key, this option may
1903 <column name="options" key="psk">
1904 Required for pre-shared key authentication. Specifies a pre-shared
1905 key for authentication that must be identical on both sides of the
1911 <group title="Patch Options">
1913 Only <code>patch</code> interfaces support these options.
1916 <column name="options" key="peer">
1917 The <ref column="name"/> of the <ref table="Interface"/> for the other
1918 side of the patch. The named <ref table="Interface"/>'s own
1919 <code>peer</code> option must specify this <ref table="Interface"/>'s
1920 name. That is, the two patch interfaces must have reversed <ref
1921 column="name"/> and <code>peer</code> values.
1925 <group title="Interface Status">
1927 Status information about interfaces attached to bridges, updated every
1928 5 seconds. Not all interfaces have all of these properties; virtual
1929 interfaces don't have a link speed, for example. Non-applicable
1930 columns will have empty values.
1932 <column name="admin_state">
1934 The administrative state of the physical network link.
1938 <column name="link_state">
1940 The observed state of the physical network link. This is ordinarily
1941 the link's carrier status. If the interface's <ref table="Port"/> is
1942 a bond configured for miimon monitoring, it is instead the network
1943 link's miimon status.
1947 <column name="link_resets">
1949 The number of times Open vSwitch has observed the
1950 <ref column="link_state"/> of this <ref table="Interface"/> change.
1954 <column name="link_speed">
1956 The negotiated speed of the physical network link.
1957 Valid values are positive integers greater than 0.
1961 <column name="duplex">
1963 The duplex mode of the physical network link.
1969 The MTU (maximum transmission unit); i.e. the largest
1970 amount of data that can fit into a single Ethernet frame.
1971 The standard Ethernet MTU is 1500 bytes. Some physical media
1972 and many kinds of virtual interfaces can be configured with
1976 This column will be empty for an interface that does not
1977 have an MTU as, for example, some kinds of tunnels do not.
1981 <column name="lacp_current">
1982 Boolean value indicating LACP status for this interface. If true, this
1983 interface has current LACP information about its LACP partner. This
1984 information may be used to monitor the health of interfaces in a LACP
1985 enabled port. This column will be empty if LACP is not enabled.
1988 <column name="status">
1989 Key-value pairs that report port status. Supported status values are
1990 <ref column="type"/>-dependent; some interfaces may not have a valid
1991 <ref column="status" key="driver_name"/>, for example.
1994 <column name="status" key="driver_name">
1995 The name of the device driver controlling the network adapter.
1998 <column name="status" key="driver_version">
1999 The version string of the device driver controlling the network
2003 <column name="status" key="firmware_version">
2004 The version string of the network adapter's firmware, if available.
2007 <column name="status" key="source_ip">
2008 The source IP address used for an IPv4 tunnel end-point, such as
2012 <column name="status" key="tunnel_egress_iface">
2013 Egress interface for tunnels. Currently only relevant for tunnels
2014 on Linux systems, this column will show the name of the interface
2015 which is responsible for routing traffic destined for the configured
2016 <ref column="options" key="remote_ip"/>. This could be an internal
2017 interface such as a bridge port.
2020 <column name="status" key="tunnel_egress_iface_carrier"
2021 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2022 Whether carrier is detected on <ref column="status"
2023 key="tunnel_egress_iface"/>.
2027 <group title="Statistics">
2029 Key-value pairs that report interface statistics. The current
2030 implementation updates these counters periodically. The update period
2031 is controlled by <ref column="other_config"
2032 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
2033 Future implementations may update them when an interface is created,
2034 when they are queried (e.g. using an OVSDB <code>select</code>
2035 operation), and just before an interface is deleted due to virtual
2036 interface hot-unplug or VM shutdown, and perhaps at other times, but
2037 not on any regular periodic basis.
2040 These are the same statistics reported by OpenFlow in its <code>struct
2041 ofp_port_stats</code> structure. If an interface does not support a
2042 given statistic, then that pair is omitted.
2044 <group title="Statistics: Successful transmit and receive counters">
2045 <column name="statistics" key="rx_packets">
2046 Number of received packets.
2048 <column name="statistics" key="rx_bytes">
2049 Number of received bytes.
2051 <column name="statistics" key="tx_packets">
2052 Number of transmitted packets.
2054 <column name="statistics" key="tx_bytes">
2055 Number of transmitted bytes.
2058 <group title="Statistics: Receive errors">
2059 <column name="statistics" key="rx_dropped">
2060 Number of packets dropped by RX.
2062 <column name="statistics" key="rx_frame_err">
2063 Number of frame alignment errors.
2065 <column name="statistics" key="rx_over_err">
2066 Number of packets with RX overrun.
2068 <column name="statistics" key="rx_crc_err">
2069 Number of CRC errors.
2071 <column name="statistics" key="rx_errors">
2072 Total number of receive errors, greater than or equal to the sum of
2076 <group title="Statistics: Transmit errors">
2077 <column name="statistics" key="tx_dropped">
2078 Number of packets dropped by TX.
2080 <column name="statistics" key="collisions">
2081 Number of collisions.
2083 <column name="statistics" key="tx_errors">
2084 Total number of transmit errors, greater than or equal to the sum of
2090 <group title="Ingress Policing">
2092 These settings control ingress policing for packets received on this
2093 interface. On a physical interface, this limits the rate at which
2094 traffic is allowed into the system from the outside; on a virtual
2095 interface (one connected to a virtual machine), this limits the rate at
2096 which the VM is able to transmit.
2099 Policing is a simple form of quality-of-service that simply drops
2100 packets received in excess of the configured rate. Due to its
2101 simplicity, policing is usually less accurate and less effective than
2102 egress QoS (which is configured using the <ref table="QoS"/> and <ref
2103 table="Queue"/> tables).
2106 Policing is currently implemented only on Linux. The Linux
2107 implementation uses a simple ``token bucket'' approach:
2111 The size of the bucket corresponds to <ref
2112 column="ingress_policing_burst"/>. Initially the bucket is full.
2115 Whenever a packet is received, its size (converted to tokens) is
2116 compared to the number of tokens currently in the bucket. If the
2117 required number of tokens are available, they are removed and the
2118 packet is forwarded. Otherwise, the packet is dropped.
2121 Whenever it is not full, the bucket is refilled with tokens at the
2122 rate specified by <ref column="ingress_policing_rate"/>.
2126 Policing interacts badly with some network protocols, and especially
2127 with fragmented IP packets. Suppose that there is enough network
2128 activity to keep the bucket nearly empty all the time. Then this token
2129 bucket algorithm will forward a single packet every so often, with the
2130 period depending on packet size and on the configured rate. All of the
2131 fragments of an IP packets are normally transmitted back-to-back, as a
2132 group. In such a situation, therefore, only one of these fragments
2133 will be forwarded and the rest will be dropped. IP does not provide
2134 any way for the intended recipient to ask for only the remaining
2135 fragments. In such a case there are two likely possibilities for what
2136 will happen next: either all of the fragments will eventually be
2137 retransmitted (as TCP will do), in which case the same problem will
2138 recur, or the sender will not realize that its packet has been dropped
2139 and data will simply be lost (as some UDP-based protocols will do).
2140 Either way, it is possible that no forward progress will ever occur.
2142 <column name="ingress_policing_rate">
2144 Maximum rate for data received on this interface, in kbps. Data
2145 received faster than this rate is dropped. Set to <code>0</code>
2146 (the default) to disable policing.
2150 <column name="ingress_policing_burst">
2151 <p>Maximum burst size for data received on this interface, in kb. The
2152 default burst size if set to <code>0</code> is 1000 kb. This value
2153 has no effect if <ref column="ingress_policing_rate"/>
2154 is <code>0</code>.</p>
2156 Specifying a larger burst size lets the algorithm be more forgiving,
2157 which is important for protocols like TCP that react severely to
2158 dropped packets. The burst size should be at least the size of the
2159 interface's MTU. Specifying a value that is numerically at least as
2160 large as 10% of <ref column="ingress_policing_rate"/> helps TCP come
2161 closer to achieving the full rate.
2166 <group title="Bidirectional Forwarding Detection (BFD)">
2168 BFD, defined in RFC 5880 and RFC 5881, allows point-to-point
2169 detection of connectivity failures by occasional transmission of
2170 BFD control messages. Open vSwitch implements BFD to serve
2171 as a more popular and standards compliant alternative to CFM.
2175 BFD operates by regularly transmitting BFD control messages at a rate
2176 negotiated independently in each direction. Each endpoint specifies
2177 the rate at which it expects to receive control messages, and the rate
2178 at which it is willing to transmit them. Open vSwitch uses a detection
2179 multiplier of three, meaning that an endpoint signals a connectivity
2180 fault if three consecutive BFD control messages fail to arrive. In the
2181 case of a unidirectional connectivity issue, the system not receiving
2182 BFD control messages signals the problem to its peer in the messages it
2187 The Open vSwitch implementation of BFD aims to comply faithfully
2188 with RFC 5880 requirements. Open vSwitch does not implement the
2189 optional Authentication or ``Echo Mode'' features.
2192 <group title="BFD Configuration">
2194 A controller sets up key-value pairs in the <ref column="bfd"/>
2195 column to enable and configure BFD.
2198 <column name="bfd" key="enable" type='{"type": "boolean"}'>
2199 True to enable BFD on this <ref table="Interface"/>. If not
2200 specified, BFD will not be enabled by default.
2203 <column name="bfd" key="min_rx"
2204 type='{"type": "integer", "minInteger": 1}'>
2205 The shortest interval, in milliseconds, at which this BFD session
2206 offers to receive BFD control messages. The remote endpoint may
2207 choose to send messages at a slower rate. Defaults to
2211 <column name="bfd" key="min_tx"
2212 type='{"type": "integer", "minInteger": 1}'>
2213 The shortest interval, in milliseconds, at which this BFD session is
2214 willing to transmit BFD control messages. Messages will actually be
2215 transmitted at a slower rate if the remote endpoint is not willing to
2216 receive as quickly as specified. Defaults to <code>100</code>.
2219 <column name="bfd" key="decay_min_rx" type='{"type": "integer"}'>
2220 An alternate receive interval, in milliseconds, that must be greater
2221 than or equal to <ref column="bfd" key="min_rx"/>. The
2222 implementation switches from <ref column="bfd" key="min_rx"/> to <ref
2223 column="bfd" key="decay_min_rx"/> when there is no obvious incoming
2224 data traffic at the interface, to reduce the CPU and bandwidth cost
2225 of monitoring an idle interface. This feature may be disabled by
2226 setting a value of 0. This feature is reset whenever <ref
2227 column="bfd" key="decay_min_rx"/> or <ref column="bfd" key="min_rx"/>
2231 <column name="bfd" key="forwarding_if_rx" type='{"type": "boolean"}'>
2232 When <code>true</code>, traffic received on the
2233 <ref table="Interface"/> is used to indicate the capability of packet
2234 I/O. BFD control packets are still transmitted and received. At
2235 least one BFD control packet must be received every 100 * <ref
2236 column="bfd" key="min_rx"/> amount of time. Otherwise, even if
2237 traffic are received, the <ref column="bfd" key="forwarding"/>
2238 will be <code>false</code>.
2241 <column name="bfd" key="cpath_down" type='{"type": "boolean"}'>
2242 Set to true to notify the remote endpoint that traffic should not be
2243 forwarded to this system for some reason other than a connectivty
2244 failure on the interface being monitored. The typical underlying
2245 reason is ``concatenated path down,'' that is, that connectivity
2246 beyond the local system is down. Defaults to false.
2249 <column name="bfd" key="check_tnl_key" type='{"type": "boolean"}'>
2250 Set to true to make BFD accept only control messages with a tunnel
2251 key of zero. By default, BFD accepts control messages with any
2255 <column name="bfd" key="bfd_local_src_mac">
2256 Set to an Ethernet address in the form
2257 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2258 to set the MAC used as source for transmitted BFD packets. The
2259 default is the mac address of the BFD enabled interface.
2262 <column name="bfd" key="bfd_local_dst_mac">
2263 Set to an Ethernet address in the form
2264 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2265 to set the MAC used as destination for transmitted BFD packets. The
2266 default is <code>00:23:20:00:00:01</code>.
2269 <column name="bfd" key="bfd_remote_dst_mac">
2270 Set to an Ethernet address in the form
2271 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>
2272 to set the MAC used for checking the destination of received BFD packets.
2273 Packets with different destination MAC will not be considered as BFD packets.
2274 If not specified the destination MAC address of received BFD packets
2278 <column name="bfd" key="bfd_src_ip">
2279 Set to an IPv4 address to set the IP address used as source for
2280 transmitted BFD packets. The default is <code>169.254.1.1</code>.
2283 <column name="bfd" key="bfd_dst_ip">
2284 Set to an IPv4 address to set the IP address used as destination
2285 for transmitted BFD packets. The default is <code>169.254.1.0</code>.
2289 <group title="BFD Status">
2291 The switch sets key-value pairs in the <ref column="bfd_status"/>
2292 column to report the status of BFD on this interface. When BFD is
2293 not enabled, with <ref column="bfd" key="enable"/>, the switch clears
2294 all key-value pairs from <ref column="bfd_status"/>.
2297 <column name="bfd_status" key="state"
2298 type='{"type": "string",
2299 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2300 Reports the state of the BFD session. The BFD session is fully
2301 healthy and negotiated if <code>UP</code>.
2304 <column name="bfd_status" key="forwarding" type='{"type": "boolean"}'>
2305 Reports whether the BFD session believes this <ref
2306 table="Interface"/> may be used to forward traffic. Typically this
2307 means the local session is signaling <code>UP</code>, and the remote
2308 system isn't signaling a problem such as concatenated path down.
2311 <column name="bfd_status" key="diagnostic">
2312 In case of a problem, set to an error message that reports what the
2313 local BFD session thinks is wrong. The error messages are defined
2314 in section 4.1 of [RFC 5880].
2317 <column name="bfd_status" key="remote_state"
2318 type='{"type": "string",
2319 "enum": ["set", ["admin_down", "down", "init", "up"]]}'>
2320 Reports the state of the remote endpoint's BFD session.
2323 <column name="bfd_status" key="remote_diagnostic">
2324 In case of a problem, set to an error message that reports what the
2325 remote endpoint's BFD session thinks is wrong. The error messages
2326 are defined in section 4.1 of [RFC 5880].
2329 <column name="bfd_status" key="flap_count"
2330 type='{"type": "integer", "minInteger": 0}'>
2331 Counts the number of <ref column="bfd_status" key="forwarding" />
2332 flaps since start. A flap is considered as a change of the
2333 <ref column="bfd_status" key="forwarding" /> value.
2338 <group title="Connectivity Fault Management">
2340 802.1ag Connectivity Fault Management (CFM) allows a group of
2341 Maintenance Points (MPs) called a Maintenance Association (MA) to
2342 detect connectivity problems with each other. MPs within a MA should
2343 have complete and exclusive interconnectivity. This is verified by
2344 occasionally broadcasting Continuity Check Messages (CCMs) at a
2345 configurable transmission interval.
2349 According to the 802.1ag specification, each Maintenance Point should
2350 be configured out-of-band with a list of Remote Maintenance Points it
2351 should have connectivity to. Open vSwitch differs from the
2352 specification in this area. It simply assumes the link is faulted if
2353 no Remote Maintenance Points are reachable, and considers it not
2358 When operating over tunnels which have no <code>in_key</code>, or an
2359 <code>in_key</code> of <code>flow</code>. CFM will only accept CCMs
2360 with a tunnel key of zero.
2363 <column name="cfm_mpid">
2365 A Maintenance Point ID (MPID) uniquely identifies each endpoint
2366 within a Maintenance Association. The MPID is used to identify this
2367 endpoint to other Maintenance Points in the MA. Each end of a link
2368 being monitored should have a different MPID. Must be configured to
2369 enable CFM on this <ref table="Interface"/>.
2372 According to the 802.1ag specification, MPIDs can only range between
2373 [1, 8191]. However, extended mode (see <ref column="other_config"
2374 key="cfm_extended"/>) supports eight byte MPIDs.
2378 <column name="cfm_flap_count">
2379 Counts the number of cfm fault flapps since boot. A flap is
2380 considered to be a change of the <ref column="cfm_fault"/> value.
2383 <column name="cfm_fault">
2385 Indicates a connectivity fault triggered by an inability to receive
2386 heartbeats from any remote endpoint. When a fault is triggered on
2387 <ref table="Interface"/>s participating in bonds, they will be
2391 Faults can be triggered for several reasons. Most importantly they
2392 are triggered when no CCMs are received for a period of 3.5 times the
2393 transmission interval. Faults are also triggered when any CCMs
2394 indicate that a Remote Maintenance Point is not receiving CCMs but
2395 able to send them. Finally, a fault is triggered if a CCM is
2396 received which indicates unexpected configuration. Notably, this
2397 case arises when a CCM is received which advertises the local MPID.
2401 <column name="cfm_fault_status" key="recv">
2402 Indicates a CFM fault was triggered due to a lack of CCMs received on
2403 the <ref table="Interface"/>.
2406 <column name="cfm_fault_status" key="rdi">
2407 Indicates a CFM fault was triggered due to the reception of a CCM with
2408 the RDI bit flagged. Endpoints set the RDI bit in their CCMs when they
2409 are not receiving CCMs themselves. This typically indicates a
2410 unidirectional connectivity failure.
2413 <column name="cfm_fault_status" key="maid">
2414 Indicates a CFM fault was triggered due to the reception of a CCM with
2415 a MAID other than the one Open vSwitch uses. CFM broadcasts are tagged
2416 with an identification number in addition to the MPID called the MAID.
2417 Open vSwitch only supports receiving CCM broadcasts tagged with the
2418 MAID it uses internally.
2421 <column name="cfm_fault_status" key="loopback">
2422 Indicates a CFM fault was triggered due to the reception of a CCM
2423 advertising the same MPID configured in the <ref column="cfm_mpid"/>
2424 column of this <ref table="Interface"/>. This may indicate a loop in
2428 <column name="cfm_fault_status" key="overflow">
2429 Indicates a CFM fault was triggered because the CFM module received
2430 CCMs from more remote endpoints than it can keep track of.
2433 <column name="cfm_fault_status" key="override">
2434 Indicates a CFM fault was manually triggered by an administrator using
2435 an <code>ovs-appctl</code> command.
2438 <column name="cfm_fault_status" key="interval">
2439 Indicates a CFM fault was triggered due to the reception of a CCM
2440 frame having an invalid interval.
2443 <column name="cfm_remote_opstate">
2444 <p>When in extended mode, indicates the operational state of the
2445 remote endpoint as either <code>up</code> or <code>down</code>. See
2446 <ref column="other_config" key="cfm_opstate"/>.
2450 <column name="cfm_health">
2452 Indicates the health of the interface as a percentage of CCM frames
2453 received over 21 <ref column="other_config" key="cfm_interval"/>s.
2454 The health of an interface is undefined if it is communicating with
2455 more than one <ref column="cfm_remote_mpids"/>. It reduces if
2456 healthy heartbeats are not received at the expected rate, and
2457 gradually improves as healthy heartbeats are received at the desired
2458 rate. Every 21 <ref column="other_config" key="cfm_interval"/>s, the
2459 health of the interface is refreshed.
2462 As mentioned above, the faults can be triggered for several reasons.
2463 The link health will deteriorate even if heartbeats are received but
2464 they are reported to be unhealthy. An unhealthy heartbeat in this
2465 context is a heartbeat for which either some fault is set or is out
2466 of sequence. The interface health can be 100 only on receiving
2467 healthy heartbeats at the desired rate.
2471 <column name="cfm_remote_mpids">
2472 When CFM is properly configured, Open vSwitch will occasionally
2473 receive CCM broadcasts. These broadcasts contain the MPID of the
2474 sending Maintenance Point. The list of MPIDs from which this
2475 <ref table="Interface"/> is receiving broadcasts from is regularly
2476 collected and written to this column.
2479 <column name="other_config" key="cfm_interval"
2480 type='{"type": "integer"}'>
2482 The interval, in milliseconds, between transmissions of CFM
2483 heartbeats. Three missed heartbeat receptions indicate a
2488 In standard operation only intervals of 3, 10, 100, 1,000, 10,000,
2489 60,000, or 600,000 ms are supported. Other values will be rounded
2490 down to the nearest value on the list. Extended mode (see <ref
2491 column="other_config" key="cfm_extended"/>) supports any interval up
2492 to 65,535 ms. In either mode, the default is 1000 ms.
2495 <p>We do not recommend using intervals less than 100 ms.</p>
2498 <column name="other_config" key="cfm_extended"
2499 type='{"type": "boolean"}'>
2500 When <code>true</code>, the CFM module operates in extended mode. This
2501 causes it to use a nonstandard destination address to avoid conflicting
2502 with compliant implementations which may be running concurrently on the
2503 network. Furthermore, extended mode increases the accuracy of the
2504 <code>cfm_interval</code> configuration parameter by breaking wire
2505 compatibility with 802.1ag compliant implementations. And extended
2506 mode allows eight byte MPIDs. Defaults to <code>false</code>.
2509 <column name="other_config" key="cfm_demand" type='{"type": "boolean"}'>
2511 When <code>true</code>, and
2512 <ref column="other_config" key="cfm_extended"/> is true, the CFM
2513 module operates in demand mode. When in demand mode, traffic
2514 received on the <ref table="Interface"/> is used to indicate
2515 liveness. CCMs are still transmitted and received. At least one
2516 CCM must be received every 100 * <ref column="other_config"
2517 key="cfm_interval"/> amount of time. Otherwise, even if traffic
2518 are received, the CFM module will raise the connectivity fault.
2522 Demand mode has a couple of caveats:
2525 To ensure that ovs-vswitchd has enough time to pull statistics
2526 from the datapath, the fault detection interval is set to
2527 3.5 * MAX(<ref column="other_config" key="cfm_interval"/>, 500)
2532 To avoid ambiguity, demand mode disables itself when there are
2533 multiple remote maintenance points.
2537 If the <ref table="Interface"/> is heavily congested, CCMs
2538 containing the <ref column="other_config" key="cfm_opstate"/>
2539 status may be dropped causing changes in the operational state to
2540 be delayed. Similarly, if CCMs containing the RDI bit are not
2541 received, unidirectional link failures may not be detected.
2547 <column name="other_config" key="cfm_opstate"
2548 type='{"type": "string", "enum": ["set", ["down", "up"]]}'>
2549 When <code>down</code>, the CFM module marks all CCMs it generates as
2550 operationally down without triggering a fault. This allows remote
2551 maintenance points to choose not to forward traffic to the
2552 <ref table="Interface"/> on which this CFM module is running.
2553 Currently, in Open vSwitch, the opdown bit of CCMs affects
2554 <ref table="Interface"/>s participating in bonds, and the bundle
2555 OpenFlow action. This setting is ignored when CFM is not in extended
2556 mode. Defaults to <code>up</code>.
2559 <column name="other_config" key="cfm_ccm_vlan"
2560 type='{"type": "integer", "minInteger": 1, "maxInteger": 4095}'>
2561 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2562 with the given value. May be the string <code>random</code> in which
2563 case each CCM will be tagged with a different randomly generated VLAN.
2566 <column name="other_config" key="cfm_ccm_pcp"
2567 type='{"type": "integer", "minInteger": 1, "maxInteger": 7}'>
2568 When set, the CFM module will apply a VLAN tag to all CCMs it generates
2569 with the given PCP value, the VLAN ID of the tag is governed by the
2570 value of <ref column="other_config" key="cfm_ccm_vlan"/>. If
2571 <ref column="other_config" key="cfm_ccm_vlan"/> is unset, a VLAN ID of
2577 <group title="Bonding Configuration">
2578 <column name="other_config" key="lacp-port-id"
2579 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2580 The LACP port ID of this <ref table="Interface"/>. Port IDs are
2581 used in LACP negotiations to identify individual ports
2582 participating in a bond.
2585 <column name="other_config" key="lacp-port-priority"
2586 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2587 The LACP port priority of this <ref table="Interface"/>. In LACP
2588 negotiations <ref table="Interface"/>s with numerically lower
2589 priorities are preferred for aggregation.
2592 <column name="other_config" key="lacp-aggregation-key"
2593 type='{"type": "integer", "minInteger": 1, "maxInteger": 65535}'>
2594 The LACP aggregation key of this <ref table="Interface"/>. <ref
2595 table="Interface"/>s with different aggregation keys may not be active
2596 within a given <ref table="Port"/> at the same time.
2600 <group title="Virtual Machine Identifiers">
2602 These key-value pairs specifically apply to an interface that
2603 represents a virtual Ethernet interface connected to a virtual
2604 machine. These key-value pairs should not be present for other types
2605 of interfaces. Keys whose names end in <code>-uuid</code> have
2606 values that uniquely identify the entity in question. For a Citrix
2607 XenServer hypervisor, these values are UUIDs in RFC 4122 format.
2608 Other hypervisors may use other formats.
2611 <column name="external_ids" key="attached-mac">
2612 The MAC address programmed into the ``virtual hardware'' for this
2613 interface, in the form
2614 <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
2615 For Citrix XenServer, this is the value of the <code>MAC</code> field
2616 in the VIF record for this interface.
2619 <column name="external_ids" key="iface-id">
2620 A system-unique identifier for the interface. On XenServer, this will
2621 commonly be the same as <ref column="external_ids" key="xs-vif-uuid"/>.
2624 <column name="external_ids" key="iface-status"
2625 type='{"type": "string",
2626 "enum": ["set", ["active", "inactive"]]}'>
2628 Hypervisors may sometimes have more than one interface associated
2629 with a given <ref column="external_ids" key="iface-id"/>, only one of
2630 which is actually in use at a given time. For example, in some
2631 circumstances XenServer has both a ``tap'' and a ``vif'' interface
2632 for a single <ref column="external_ids" key="iface-id"/>, but only
2633 uses one of them at a time. A hypervisor that behaves this way must
2634 mark the currently in use interface <code>active</code> and the
2635 others <code>inactive</code>. A hypervisor that never has more than
2636 one interface for a given <ref column="external_ids" key="iface-id"/>
2637 may mark that interface <code>active</code> or omit <ref
2638 column="external_ids" key="iface-status"/> entirely.
2642 During VM migration, a given <ref column="external_ids"
2643 key="iface-id"/> might transiently be marked <code>active</code> on
2644 two different hypervisors. That is, <code>active</code> means that
2645 this <ref column="external_ids" key="iface-id"/> is the active
2646 instance within a single hypervisor, not in a broader scope.
2647 There is one exception: some hypervisors support ``migration'' from a
2648 given hypervisor to itself (most often for test purposes). During
2649 such a ``migration,'' two instances of a single <ref
2650 column="external_ids" key="iface-id"/> might both be briefly marked
2651 <code>active</code> on a single hypervisor.
2655 <column name="external_ids" key="xs-vif-uuid">
2656 The virtual interface associated with this interface.
2659 <column name="external_ids" key="xs-network-uuid">
2660 The virtual network to which this interface is attached.
2663 <column name="external_ids" key="vm-id">
2664 The VM to which this interface belongs. On XenServer, this will be the
2665 same as <ref column="external_ids" key="xs-vm-uuid"/>.
2668 <column name="external_ids" key="xs-vm-uuid">
2669 The VM to which this interface belongs.
2673 <group title="VLAN Splinters">
2675 The ``VLAN splinters'' feature increases Open vSwitch compatibility
2676 with buggy network drivers in old versions of Linux that do not
2677 properly support VLANs when VLAN devices are not used, at some cost
2678 in memory and performance.
2682 When VLAN splinters are enabled on a particular interface, Open vSwitch
2683 creates a VLAN device for each in-use VLAN. For sending traffic tagged
2684 with a VLAN on the interface, it substitutes the VLAN device. Traffic
2685 received on the VLAN device is treated as if it had been received on
2686 the interface on the particular VLAN.
2690 VLAN splinters consider a VLAN to be in use if:
2695 The VLAN is the <ref table="Port" column="tag"/> value in any <ref
2696 table="Port"/> record.
2700 The VLAN is listed within the <ref table="Port" column="trunks"/>
2701 column of the <ref table="Port"/> record of an interface on which
2702 VLAN splinters are enabled.
2704 An empty <ref table="Port" column="trunks"/> does not influence the
2705 in-use VLANs: creating 4,096 VLAN devices is impractical because it
2706 will exceed the current 1,024 port per datapath limit.
2710 An OpenFlow flow within any bridge matches the VLAN.
2715 The same set of in-use VLANs applies to every interface on which VLAN
2716 splinters are enabled. That is, the set is not chosen separately for
2717 each interface but selected once as the union of all in-use VLANs based
2722 It does not make sense to enable VLAN splinters on an interface for an
2723 access port, or on an interface that is not a physical port.
2727 VLAN splinters are deprecated. When broken device drivers are no
2728 longer in widespread use, we will delete this feature.
2731 <column name="other_config" key="enable-vlan-splinters"
2732 type='{"type": "boolean"}'>
2734 Set to <code>true</code> to enable VLAN splinters on this interface.
2735 Defaults to <code>false</code>.
2739 VLAN splinters increase kernel and userspace memory overhead, so do
2740 not use them unless they are needed.
2744 VLAN splinters do not support 802.1p priority tags. Received
2745 priorities will appear to be 0, regardless of their actual values,
2746 and priorities on transmitted packets will also be cleared to 0.
2751 <group title="Common Columns">
2752 The overall purpose of these columns is described under <code>Common
2753 Columns</code> at the beginning of this document.
2755 <column name="other_config"/>
2756 <column name="external_ids"/>
2760 <table name="Flow_Table" title="OpenFlow table configuration">
2761 <p>Configuration for a particular OpenFlow table.</p>
2763 <column name="name">
2764 The table's name. Set this column to change the name that controllers
2765 will receive when they request table statistics, e.g. <code>ovs-ofctl
2766 dump-tables</code>. The name does not affect switch behavior.
2769 <column name="flow_limit">
2770 If set, limits the number of flows that may be added to the table. Open
2771 vSwitch may limit the number of flows in a table for other reasons,
2772 e.g. due to hardware limitations or for resource availability or
2773 performance reasons.
2776 <column name="overflow_policy">
2778 Controls the switch's behavior when an OpenFlow flow table modification
2779 request would add flows in excess of <ref column="flow_limit"/>. The
2780 supported values are:
2784 <dt><code>refuse</code></dt>
2786 Refuse to add the flow or flows. This is also the default policy
2787 when <ref column="overflow_policy"/> is unset.
2790 <dt><code>evict</code></dt>
2792 Delete the flow that will expire soonest. See <ref column="groups"/>
2798 <column name="groups">
2800 When <ref column="overflow_policy"/> is <code>evict</code>, this
2801 controls how flows are chosen for eviction when the flow table would
2802 otherwise exceed <ref column="flow_limit"/> flows. Its value is a set
2803 of NXM fields or sub-fields, each of which takes one of the forms
2804 <code><var>field</var>[]</code> or
2805 <code><var>field</var>[<var>start</var>..<var>end</var>]</code>,
2806 e.g. <code>NXM_OF_IN_PORT[]</code>. Please see
2807 <code>nicira-ext.h</code> for a complete list of NXM field names.
2811 When a flow must be evicted due to overflow, the flow to evict is
2812 chosen through an approximation of the following algorithm:
2817 Divide the flows in the table into groups based on the values of the
2818 specified fields or subfields, so that all of the flows in a given
2819 group have the same values for those fields. If a flow does not
2820 specify a given field, that field's value is treated as 0.
2824 Consider the flows in the largest group, that is, the group that
2825 contains the greatest number of flows. If two or more groups all
2826 have the same largest number of flows, consider the flows in all of
2831 Among the flows under consideration, choose the flow that expires
2832 soonest for eviction.
2837 The eviction process only considers flows that have an idle timeout or
2838 a hard timeout. That is, eviction never deletes permanent flows.
2839 (Permanent flows do count against <ref column="flow_limit"/>.)
2843 Open vSwitch ignores any invalid or unknown field specifications.
2847 When <ref column="overflow_policy"/> is not <code>evict</code>, this
2848 column has no effect.
2852 <column name="prefixes">
2854 This string set specifies which fields should be used for
2855 address prefix tracking. Prefix tracking allows the
2856 classifier to skip rules with longer than necessary prefixes,
2857 resulting in better wildcarding for datapath flows.
2860 Prefix tracking may be beneficial when a flow table contains
2861 matches on IP address fields with different prefix lengths.
2862 For example, when a flow table contains IP address matches on
2863 both full addresses and proper prefixes, the full address
2864 matches will typically cause the datapath flow to un-wildcard
2865 the whole address field (depending on flow entry priorities).
2866 In this case each packet with a different address gets handed
2867 to the userspace for flow processing and generates its own
2868 datapath flow. With prefix tracking enabled for the address
2869 field in question packets with addresses matching shorter
2870 prefixes would generate datapath flows where the irrelevant
2871 address bits are wildcarded, allowing the same datapath flow
2872 to handle all the packets within the prefix in question. In
2873 this case many userspace upcalls can be avoided and the
2874 overall performance can be better.
2877 This is a performance optimization only, so packets will
2878 receive the same treatment with or without prefix tracking.
2881 The supported fields are: <code>tun_id</code>,
2882 <code>tun_src</code>, <code>tun_dst</code>,
2883 <code>nw_src</code>, <code>nw_dst</code> (or aliases
2884 <code>ip_src</code> and <code>ip_dst</code>),
2885 <code>ipv6_src</code>, and <code>ipv6_dst</code>. (Using this
2886 feature for <code>tun_id</code> would only make sense if the
2887 tunnel IDs have prefix structure similar to IP addresses.)
2891 By default, the <code>prefixes=ip_dst,ip_src</code> are used
2892 on each flow table. This instructs the flow classifier to
2893 track the IP destination and source addresses used by the
2894 rules in this specific flow table.
2898 The keyword <code>none</code> is recognized as an explicit
2899 override of the default values, causing no prefix fields to be
2904 To set the prefix fields, the flow table record needs to
2909 <dt><code>ovs-vsctl set Bridge br0 flow_tables:0=@N1 -- --id=@N1 create Flow_Table name=table0</code></dt>
2911 Creates a flow table record for the OpenFlow table number 0.
2914 <dt><code>ovs-vsctl set Flow_Table table0 prefixes=ip_dst,ip_src</code></dt>
2916 Enables prefix tracking for IP source and destination
2922 There is a maximum number of fields that can be enabled for any
2923 one flow table. Currently this limit is 3.
2927 <group title="Common Columns">
2928 The overall purpose of these columns is described under <code>Common
2929 Columns</code> at the beginning of this document.
2931 <column name="external_ids"/>
2935 <table name="QoS" title="Quality of Service configuration">
2936 <p>Quality of Service (QoS) configuration for each Port that
2939 <column name="type">
2940 <p>The type of QoS to implement. The currently defined types are
2943 <dt><code>linux-htb</code></dt>
2945 Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
2946 <code>http://linux.die.net/man/8/tc-htb</code>) and the HTB manual
2947 (<code>http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm</code>)
2948 for information on how this classifier works and how to configure it.
2952 <dt><code>linux-hfsc</code></dt>
2954 Linux "Hierarchical Fair Service Curve" classifier.
2955 See <code>http://linux-ip.net/articles/hfsc.en/</code> for
2956 information on how this classifier works.
2961 <column name="queues">
2962 <p>A map from queue numbers to <ref table="Queue"/> records. The
2963 supported range of queue numbers depend on <ref column="type"/>. The
2964 queue numbers are the same as the <code>queue_id</code> used in
2965 OpenFlow in <code>struct ofp_action_enqueue</code> and other
2969 Queue 0 is the ``default queue.'' It is used by OpenFlow output
2970 actions when no specific queue has been set. When no configuration for
2971 queue 0 is present, it is automatically configured as if a <ref
2972 table="Queue"/> record with empty <ref table="Queue" column="dscp"/>
2973 and <ref table="Queue" column="other_config"/> columns had been
2975 (Before version 1.6, Open vSwitch would leave queue 0 unconfigured in
2976 this case. With some queuing disciplines, this dropped all packets
2977 destined for the default queue.)
2981 <group title="Configuration for linux-htb and linux-hfsc">
2983 The <code>linux-htb</code> and <code>linux-hfsc</code> classes support
2984 the following key-value pair:
2987 <column name="other_config" key="max-rate" type='{"type": "integer"}'>
2988 Maximum rate shared by all queued traffic, in bit/s. Optional. If not
2989 specified, for physical interfaces, the default is the link rate. For
2990 other interfaces or if the link rate cannot be determined, the default
2991 is currently 100 Mbps.
2995 <group title="Common Columns">
2996 The overall purpose of these columns is described under <code>Common
2997 Columns</code> at the beginning of this document.
2999 <column name="other_config"/>
3000 <column name="external_ids"/>
3004 <table name="Queue" title="QoS output queue.">
3005 <p>A configuration for a port output queue, used in configuring Quality of
3006 Service (QoS) features. May be referenced by <ref column="queues"
3007 table="QoS"/> column in <ref table="QoS"/> table.</p>
3009 <column name="dscp">
3010 If set, Open vSwitch will mark all traffic egressing this
3011 <ref table="Queue"/> with the given DSCP bits. Traffic egressing the
3012 default <ref table="Queue"/> is only marked if it was explicitly selected
3013 as the <ref table="Queue"/> at the time the packet was output. If unset,
3014 the DSCP bits of traffic egressing this <ref table="Queue"/> will remain
3018 <group title="Configuration for linux-htb QoS">
3020 <ref table="QoS"/> <ref table="QoS" column="type"/>
3021 <code>linux-htb</code> may use <code>queue_id</code>s less than 61440.
3022 It has the following key-value pairs defined.
3025 <column name="other_config" key="min-rate"
3026 type='{"type": "integer", "minInteger": 1}'>
3027 Minimum guaranteed bandwidth, in bit/s.
3030 <column name="other_config" key="max-rate"
3031 type='{"type": "integer", "minInteger": 1}'>
3032 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3033 queue's rate will not be allowed to exceed the specified value, even
3034 if excess bandwidth is available. If unspecified, defaults to no
3038 <column name="other_config" key="burst"
3039 type='{"type": "integer", "minInteger": 1}'>
3040 Burst size, in bits. This is the maximum amount of ``credits'' that a
3041 queue can accumulate while it is idle. Optional. Details of the
3042 <code>linux-htb</code> implementation require a minimum burst size, so
3043 a too-small <code>burst</code> will be silently ignored.
3046 <column name="other_config" key="priority"
3047 type='{"type": "integer", "minInteger": 0, "maxInteger": 4294967295}'>
3048 A queue with a smaller <code>priority</code> will receive all the
3049 excess bandwidth that it can use before a queue with a larger value
3050 receives any. Specific priority values are unimportant; only relative
3051 ordering matters. Defaults to 0 if unspecified.
3055 <group title="Configuration for linux-hfsc QoS">
3057 <ref table="QoS"/> <ref table="QoS" column="type"/>
3058 <code>linux-hfsc</code> may use <code>queue_id</code>s less than 61440.
3059 It has the following key-value pairs defined.
3062 <column name="other_config" key="min-rate"
3063 type='{"type": "integer", "minInteger": 1}'>
3064 Minimum guaranteed bandwidth, in bit/s.
3067 <column name="other_config" key="max-rate"
3068 type='{"type": "integer", "minInteger": 1}'>
3069 Maximum allowed bandwidth, in bit/s. Optional. If specified, the
3070 queue's rate will not be allowed to exceed the specified value, even if
3071 excess bandwidth is available. If unspecified, defaults to no
3076 <group title="Common Columns">
3077 The overall purpose of these columns is described under <code>Common
3078 Columns</code> at the beginning of this document.
3080 <column name="other_config"/>
3081 <column name="external_ids"/>
3085 <table name="Mirror" title="Port mirroring.">
3086 <p>A port mirror within a <ref table="Bridge"/>.</p>
3087 <p>A port mirror configures a bridge to send selected frames to special
3088 ``mirrored'' ports, in addition to their normal destinations. Mirroring
3089 traffic may also be referred to as SPAN or RSPAN, depending on how
3090 the mirrored traffic is sent.</p>
3092 <column name="name">
3093 Arbitrary identifier for the <ref table="Mirror"/>.
3096 <group title="Selecting Packets for Mirroring">
3098 To be selected for mirroring, a given packet must enter or leave the
3099 bridge through a selected port and it must also be in one of the
3103 <column name="select_all">
3104 If true, every packet arriving or departing on any port is
3105 selected for mirroring.
3108 <column name="select_dst_port">
3109 Ports on which departing packets are selected for mirroring.
3112 <column name="select_src_port">
3113 Ports on which arriving packets are selected for mirroring.
3116 <column name="select_vlan">
3117 VLANs on which packets are selected for mirroring. An empty set
3118 selects packets on all VLANs.
3122 <group title="Mirroring Destination Configuration">
3124 These columns are mutually exclusive. Exactly one of them must be
3128 <column name="output_port">
3129 <p>Output port for selected packets, if nonempty.</p>
3130 <p>Specifying a port for mirror output reserves that port exclusively
3131 for mirroring. No frames other than those selected for mirroring
3133 will be forwarded to the port, and any frames received on the port
3134 will be discarded.</p>
3136 The output port may be any kind of port supported by Open vSwitch.
3137 It may be, for example, a physical port (sometimes called SPAN) or a
3142 <column name="output_vlan">
3143 <p>Output VLAN for selected packets, if nonempty.</p>
3144 <p>The frames will be sent out all ports that trunk
3145 <ref column="output_vlan"/>, as well as any ports with implicit VLAN
3146 <ref column="output_vlan"/>. When a mirrored frame is sent out a
3147 trunk port, the frame's VLAN tag will be set to
3148 <ref column="output_vlan"/>, replacing any existing tag; when it is
3149 sent out an implicit VLAN port, the frame will not be tagged. This
3150 type of mirroring is sometimes called RSPAN.</p>
3152 See the documentation for
3153 <ref column="other_config" key="forward-bpdu"/> in the
3154 <ref table="Interface"/> table for a list of destination MAC
3155 addresses which will not be mirrored to a VLAN to avoid confusing
3156 switches that interpret the protocols that they represent.
3158 <p><em>Please note:</em> Mirroring to a VLAN can disrupt a network that
3159 contains unmanaged switches. Consider an unmanaged physical switch
3160 with two ports: port 1, connected to an end host, and port 2,
3161 connected to an Open vSwitch configured to mirror received packets
3162 into VLAN 123 on port 2. Suppose that the end host sends a packet on
3163 port 1 that the physical switch forwards to port 2. The Open vSwitch
3164 forwards this packet to its destination and then reflects it back on
3165 port 2 in VLAN 123. This reflected packet causes the unmanaged
3166 physical switch to replace the MAC learning table entry, which
3167 correctly pointed to port 1, with one that incorrectly points to port
3168 2. Afterward, the physical switch will direct packets destined for
3169 the end host to the Open vSwitch on port 2, instead of to the end
3170 host on port 1, disrupting connectivity. If mirroring to a VLAN is
3171 desired in this scenario, then the physical switch must be replaced
3172 by one that learns Ethernet addresses on a per-VLAN basis. In
3173 addition, learning should be disabled on the VLAN containing mirrored
3174 traffic. If this is not done then intermediate switches will learn
3175 the MAC address of each end host from the mirrored traffic. If
3176 packets being sent to that end host are also mirrored, then they will
3177 be dropped since the switch will attempt to send them out the input
3178 port. Disabling learning for the VLAN will cause the switch to
3179 correctly send the packet out all ports configured for that VLAN. If
3180 Open vSwitch is being used as an intermediate switch, learning can be
3181 disabled by adding the mirrored VLAN to <ref column="flood_vlans"/>
3182 in the appropriate <ref table="Bridge"/> table or tables.</p>
3184 Mirroring to a GRE tunnel has fewer caveats than mirroring to a
3185 VLAN and should generally be preferred.
3190 <group title="Statistics: Mirror counters">
3192 Key-value pairs that report mirror statistics. The update period
3193 is controlled by <ref column="other_config"
3194 key="stats-update-interval"/> in the <code>Open_vSwitch</code> table.
3196 <column name="statistics" key="tx_packets">
3197 Number of packets transmitted through this mirror.
3199 <column name="statistics" key="tx_bytes">
3200 Number of bytes transmitted through this mirror.
3204 <group title="Common Columns">
3205 The overall purpose of these columns is described under <code>Common
3206 Columns</code> at the beginning of this document.
3208 <column name="external_ids"/>
3212 <table name="Controller" title="OpenFlow controller configuration.">
3213 <p>An OpenFlow controller.</p>
3216 Open vSwitch supports two kinds of OpenFlow controllers:
3220 <dt>Primary controllers</dt>
3223 This is the kind of controller envisioned by the OpenFlow 1.0
3224 specification. Usually, a primary controller implements a network
3225 policy by taking charge of the switch's flow table.
3229 Open vSwitch initiates and maintains persistent connections to
3230 primary controllers, retrying the connection each time it fails or
3231 drops. The <ref table="Bridge" column="fail_mode"/> column in the
3232 <ref table="Bridge"/> table applies to primary controllers.
3236 Open vSwitch permits a bridge to have any number of primary
3237 controllers. When multiple controllers are configured, Open
3238 vSwitch connects to all of them simultaneously. Because
3239 OpenFlow 1.0 does not specify how multiple controllers
3240 coordinate in interacting with a single switch, more than
3241 one primary controller should be specified only if the
3242 controllers are themselves designed to coordinate with each
3243 other. (The Nicira-defined <code>NXT_ROLE</code> OpenFlow
3244 vendor extension may be useful for this.)
3247 <dt>Service controllers</dt>
3250 These kinds of OpenFlow controller connections are intended for
3251 occasional support and maintenance use, e.g. with
3252 <code>ovs-ofctl</code>. Usually a service controller connects only
3253 briefly to inspect or modify some of a switch's state.
3257 Open vSwitch listens for incoming connections from service
3258 controllers. The service controllers initiate and, if necessary,
3259 maintain the connections from their end. The <ref table="Bridge"
3260 column="fail_mode"/> column in the <ref table="Bridge"/> table does
3261 not apply to service controllers.
3265 Open vSwitch supports configuring any number of service controllers.
3271 The <ref column="target"/> determines the type of controller.
3274 <group title="Core Features">
3275 <column name="target">
3276 <p>Connection method for controller.</p>
3278 The following connection methods are currently supported for primary
3282 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3284 <p>The specified SSL <var>port</var> on the host at the
3285 given <var>ip</var>, which must be expressed as an IP
3286 address (not a DNS name). The <ref table="Open_vSwitch"
3287 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3288 table must point to a valid SSL configuration when this form
3290 <p>If <var>port</var> is not specified, it currently
3291 defaults to 6633. In the future, the default will change to
3292 6653, which is the IANA-defined value.</p>
3293 <p>SSL support is an optional feature that is not always built as
3294 part of Open vSwitch.</p>
3296 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3299 The specified TCP <var>port</var> on the host at the given
3300 <var>ip</var>, which must be expressed as an IP address (not a
3301 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3302 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3303 e.g. <code>tcp:[::1]:6632</code>.
3306 If <var>port</var> is not specified, it currently defaults to
3307 6633. In the future, the default will change to 6653, which is
3308 the IANA-defined value.
3313 The following connection methods are currently supported for service
3317 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3320 Listens for SSL connections on the specified TCP <var>port</var>.
3321 If <var>ip</var>, which must be expressed as an IP address (not a
3322 DNS name), is specified, then connections are restricted to the
3323 specified local IP address (either IPv4 or IPv6). If
3324 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3325 e.g. <code>pssl:6632:[::1]</code>.
3328 If <var>port</var> is not specified, it currently defaults to
3329 6633. If <var>ip</var> is not specified then it listens only on
3330 IPv4 (but not IPv6) addresses. The
3331 <ref table="Open_vSwitch" column="ssl"/>
3332 column in the <ref table="Open_vSwitch"/> table must point to a
3333 valid SSL configuration when this form is used.
3336 If <var>port</var> is not specified, it currently defaults to
3337 6633. In the future, the default will change to 6653, which is
3338 the IANA-defined value.
3341 SSL support is an optional feature that is not always built as
3342 part of Open vSwitch.
3345 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3348 Listens for connections on the specified TCP <var>port</var>. If
3349 <var>ip</var>, which must be expressed as an IP address (not a
3350 DNS name), is specified, then connections are restricted to the
3351 specified local IP address (either IPv4 or IPv6). If
3352 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3353 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3354 specified then it listens only on IPv4 addresses.
3357 If <var>port</var> is not specified, it currently defaults to
3358 6633. In the future, the default will change to 6653, which is
3359 the IANA-defined value.
3363 <p>When multiple controllers are configured for a single bridge, the
3364 <ref column="target"/> values must be unique. Duplicate
3365 <ref column="target"/> values yield unspecified results.</p>
3368 <column name="connection_mode">
3369 <p>If it is specified, this setting must be one of the following
3370 strings that describes how Open vSwitch contacts this OpenFlow
3371 controller over the network:</p>
3374 <dt><code>in-band</code></dt>
3375 <dd>In this mode, this controller's OpenFlow traffic travels over the
3376 bridge associated with the controller. With this setting, Open
3377 vSwitch allows traffic to and from the controller regardless of the
3378 contents of the OpenFlow flow table. (Otherwise, Open vSwitch
3379 would never be able to connect to the controller, because it did
3380 not have a flow to enable it.) This is the most common connection
3381 mode because it is not necessary to maintain two independent
3383 <dt><code>out-of-band</code></dt>
3384 <dd>In this mode, OpenFlow traffic uses a control network separate
3385 from the bridge associated with this controller, that is, the
3386 bridge does not use any of its own network devices to communicate
3387 with the controller. The control network must be configured
3388 separately, before or after <code>ovs-vswitchd</code> is started.
3392 <p>If not specified, the default is implementation-specific.</p>
3396 <group title="Controller Failure Detection and Handling">
3397 <column name="max_backoff">
3398 Maximum number of milliseconds to wait between connection attempts.
3399 Default is implementation-specific.
3402 <column name="inactivity_probe">
3403 Maximum number of milliseconds of idle time on connection to
3404 controller before sending an inactivity probe message. If Open
3405 vSwitch does not communicate with the controller for the specified
3406 number of seconds, it will send a probe. If a response is not
3407 received for the same additional amount of time, Open vSwitch
3408 assumes the connection has been broken and attempts to reconnect.
3409 Default is implementation-specific. A value of 0 disables
3414 <group title="Asynchronous Messages">
3416 OpenFlow switches send certain messages to controllers spontanenously,
3417 that is, not in response to any request from the controller. These
3418 messages are called ``asynchronous messages.'' These columns allow
3419 asynchronous messages to be limited or disabled to ensure the best use
3420 of network resources.
3423 <column name="enable_async_messages">
3424 The OpenFlow protocol enables asynchronous messages at time of
3425 connection establishment, which means that a controller can receive
3426 asynchronous messages, potentially many of them, even if it turns them
3427 off immediately after connecting. Set this column to
3428 <code>false</code> to change Open vSwitch behavior to disable, by
3429 default, all asynchronous messages. The controller can use the
3430 <code>NXT_SET_ASYNC_CONFIG</code> Nicira extension to OpenFlow to turn
3431 on any messages that it does want to receive, if any.
3434 <group title="Controller Rate Limiting">
3436 A switch can forward packets to a controller over the OpenFlow
3437 protocol. Forwarding packets this way at too high a rate can
3438 overwhelm a controller, frustrate use of the OpenFlow connection for
3439 other purposes, increase the latency of flow setup, and use an
3440 unreasonable amount of bandwidth. Therefore, Open vSwitch supports
3441 limiting the rate of packet forwarding to a controller.
3445 There are two main reasons in OpenFlow for a packet to be sent to a
3446 controller: either the packet ``misses'' in the flow table, that is,
3447 there is no matching flow, or a flow table action says to send the
3448 packet to the controller. Open vSwitch limits the rate of each kind
3449 of packet separately at the configured rate. Therefore, the actual
3450 rate that packets are sent to the controller can be up to twice the
3451 configured rate, when packets are sent for both reasons.
3455 This feature is specific to forwarding packets over an OpenFlow
3456 connection. It is not general-purpose QoS. See the <ref
3457 table="QoS"/> table for quality of service configuration, and <ref
3458 column="ingress_policing_rate" table="Interface"/> in the <ref
3459 table="Interface"/> table for ingress policing configuration.
3462 <column name="controller_rate_limit">
3464 The maximum rate at which the switch will forward packets to the
3465 OpenFlow controller, in packets per second. If no value is
3466 specified, rate limiting is disabled.
3470 <column name="controller_burst_limit">
3472 When a high rate triggers rate-limiting, Open vSwitch queues
3473 packets to the controller for each port and transmits them to the
3474 controller at the configured rate. This value limits the number of
3475 queued packets. Ports on a bridge share the packet queue fairly.
3479 This value has no effect unless <ref
3480 column="controller_rate_limit"/> is configured. The current
3481 default when this value is not specified is one-quarter of <ref
3482 column="controller_rate_limit"/>, meaning that queuing can delay
3483 forwarding a packet to the controller by up to 250 ms.
3487 <group title="Controller Rate Limiting Statistics">
3489 These values report the effects of rate limiting. Their values are
3490 relative to establishment of the most recent OpenFlow connection,
3491 or since rate limiting was enabled, whichever happened more
3492 recently. Each consists of two values, one with <code>TYPE</code>
3493 replaced by <code>miss</code> for rate limiting flow table misses,
3494 and the other with <code>TYPE</code> replaced by
3495 <code>action</code> for rate limiting packets sent by OpenFlow
3500 These statistics are reported only when controller rate limiting is
3504 <column name="status" key="packet-in-TYPE-bypassed"
3505 type='{"type": "integer", "minInteger": 0}'>
3506 Number of packets sent directly to the controller, without queuing,
3507 because the rate did not exceed the configured maximum.
3510 <column name="status" key="packet-in-TYPE-queued"
3511 type='{"type": "integer", "minInteger": 0}'>
3512 Number of packets added to the queue to send later.
3515 <column name="status" key="packet-in-TYPE-dropped"
3516 type='{"type": "integer", "minInteger": 0}'>
3517 Number of packets added to the queue that were later dropped due to
3518 overflow. This value is less than or equal to <ref column="status"
3519 key="packet-in-TYPE-queued"/>.
3522 <column name="status" key="packet-in-TYPE-backlog"
3523 type='{"type": "integer", "minInteger": 0}'>
3524 Number of packets currently queued. The other statistics increase
3525 monotonically, but this one fluctuates between 0 and the <ref
3526 column="controller_burst_limit"/> as conditions change.
3532 <group title="Additional In-Band Configuration">
3533 <p>These values are considered only in in-band control mode (see
3534 <ref column="connection_mode"/>).</p>
3536 <p>When multiple controllers are configured on a single bridge, there
3537 should be only one set of unique values in these columns. If different
3538 values are set for these columns in different controllers, the effect
3541 <column name="local_ip">
3542 The IP address to configure on the local port,
3543 e.g. <code>192.168.0.123</code>. If this value is unset, then
3544 <ref column="local_netmask"/> and <ref column="local_gateway"/> are
3548 <column name="local_netmask">
3549 The IP netmask to configure on the local port,
3550 e.g. <code>255.255.255.0</code>. If <ref column="local_ip"/> is set
3551 but this value is unset, then the default is chosen based on whether
3552 the IP address is class A, B, or C.
3555 <column name="local_gateway">
3556 The IP address of the gateway to configure on the local port, as a
3557 string, e.g. <code>192.168.0.1</code>. Leave this column unset if
3558 this network has no gateway.
3562 <group title="Controller Status">
3563 <column name="is_connected">
3564 <code>true</code> if currently connected to this controller,
3565 <code>false</code> otherwise.
3569 type='{"type": "string", "enum": ["set", ["other", "master", "slave"]]}'>
3570 <p>The level of authority this controller has on the associated
3571 bridge. Possible values are:</p>
3573 <dt><code>other</code></dt>
3574 <dd>Allows the controller access to all OpenFlow features.</dd>
3575 <dt><code>master</code></dt>
3576 <dd>Equivalent to <code>other</code>, except that there may be at
3577 most one master controller at a time. When a controller configures
3578 itself as <code>master</code>, any existing master is demoted to
3579 the <code>slave</code> role.</dd>
3580 <dt><code>slave</code></dt>
3581 <dd>Allows the controller read-only access to OpenFlow features.
3582 Attempts to modify the flow table will be rejected with an
3583 error. Slave controllers do not receive OFPT_PACKET_IN or
3584 OFPT_FLOW_REMOVED messages, but they do receive OFPT_PORT_STATUS
3589 <column name="status" key="last_error">
3590 A human-readable description of the last error on the connection
3591 to the controller; i.e. <code>strerror(errno)</code>. This key
3592 will exist only if an error has occurred.
3595 <column name="status" key="state"
3596 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3598 The state of the connection to the controller:
3601 <dt><code>VOID</code></dt>
3602 <dd>Connection is disabled.</dd>
3604 <dt><code>BACKOFF</code></dt>
3605 <dd>Attempting to reconnect at an increasing period.</dd>
3607 <dt><code>CONNECTING</code></dt>
3608 <dd>Attempting to connect.</dd>
3610 <dt><code>ACTIVE</code></dt>
3611 <dd>Connected, remote host responsive.</dd>
3613 <dt><code>IDLE</code></dt>
3614 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3617 These values may change in the future. They are provided only for
3622 <column name="status" key="sec_since_connect"
3623 type='{"type": "integer", "minInteger": 0}'>
3624 The amount of time since this controller last successfully connected to
3625 the switch (in seconds). Value is empty if controller has never
3626 successfully connected.
3629 <column name="status" key="sec_since_disconnect"
3630 type='{"type": "integer", "minInteger": 1}'>
3631 The amount of time since this controller last disconnected from
3632 the switch (in seconds). Value is empty if controller has never
3637 <group title="Connection Parameters">
3639 Additional configuration for a connection between the controller
3640 and the Open vSwitch.
3643 <column name="other_config" key="dscp"
3644 type='{"type": "integer"}'>
3645 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3646 in the Type of Service (TOS) field in the IP header. DSCP provides a
3647 mechanism to classify the network traffic and provide Quality of
3648 Service (QoS) on IP networks.
3650 The DSCP value specified here is used when establishing the connection
3651 between the controller and the Open vSwitch. If no value is specified,
3652 a default value of 48 is chosen. Valid DSCP values must be in the
3658 <group title="Common Columns">
3659 The overall purpose of these columns is described under <code>Common
3660 Columns</code> at the beginning of this document.
3662 <column name="external_ids"/>
3663 <column name="other_config"/>
3667 <table name="Manager" title="OVSDB management connection.">
3669 Configuration for a database connection to an Open vSwitch database
3674 This table primarily configures the Open vSwitch database
3675 (<code>ovsdb-server</code>), not the Open vSwitch switch
3676 (<code>ovs-vswitchd</code>). The switch does read the table to determine
3677 what connections should be treated as in-band.
3681 The Open vSwitch database server can initiate and maintain active
3682 connections to remote clients. It can also listen for database
3686 <group title="Core Features">
3687 <column name="target">
3688 <p>Connection method for managers.</p>
3690 The following connection methods are currently supported:
3693 <dt><code>ssl:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3696 The specified SSL <var>port</var> on the host at the given
3697 <var>ip</var>, which must be expressed as an IP address
3698 (not a DNS name). The <ref table="Open_vSwitch"
3699 column="ssl"/> column in the <ref table="Open_vSwitch"/>
3700 table must point to a valid SSL configuration when this
3704 If <var>port</var> is not specified, it currently defaults
3705 to 6632. In the future, the default will change to 6640,
3706 which is the IANA-defined value.
3709 SSL support is an optional feature that is not always
3710 built as part of Open vSwitch.
3714 <dt><code>tcp:<var>ip</var></code>[<code>:<var>port</var></code>]</dt>
3717 The specified TCP <var>port</var> on the host at the given
3718 <var>ip</var>, which must be expressed as an IP address (not a
3719 DNS name), where <var>ip</var> can be IPv4 or IPv6 address. If
3720 <var>ip</var> is an IPv6 address, wrap it in square brackets,
3721 e.g. <code>tcp:[::1]:6632</code>.
3724 If <var>port</var> is not specified, it currently defaults
3725 to 6632. In the future, the default will change to 6640,
3726 which is the IANA-defined value.
3729 <dt><code>pssl:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3732 Listens for SSL connections on the specified TCP <var>port</var>.
3733 Specify 0 for <var>port</var> to have the kernel automatically
3734 choose an available port. If <var>ip</var>, which must be
3735 expressed as an IP address (not a DNS name), is specified, then
3736 connections are restricted to the specified local IP address
3737 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3738 address, wrap in square brackets,
3739 e.g. <code>pssl:6632:[::1]</code>. If <var>ip</var> is not
3740 specified then it listens only on IPv4 (but not IPv6) addresses.
3741 The <ref table="Open_vSwitch" column="ssl"/> column in the <ref
3742 table="Open_vSwitch"/> table must point to a valid SSL
3743 configuration when this form is used.
3746 If <var>port</var> is not specified, it currently defaults
3747 to 6632. In the future, the default will change to 6640,
3748 which is the IANA-defined value.
3751 SSL support is an optional feature that is not always built as
3752 part of Open vSwitch.
3755 <dt><code>ptcp:</code>[<var>port</var>][<code>:<var>ip</var></code>]</dt>
3758 Listens for connections on the specified TCP <var>port</var>.
3759 Specify 0 for <var>port</var> to have the kernel automatically
3760 choose an available port. If <var>ip</var>, which must be
3761 expressed as an IP address (not a DNS name), is specified, then
3762 connections are restricted to the specified local IP address
3763 (either IPv4 or IPv6 address). If <var>ip</var> is an IPv6
3764 address, wrap it in square brackets,
3765 e.g. <code>ptcp:6632:[::1]</code>. If <var>ip</var> is not
3766 specified then it listens only on IPv4 addresses.
3769 If <var>port</var> is not specified, it currently defaults
3770 to 6632. In the future, the default will change to 6640,
3771 which is the IANA-defined value.
3775 <p>When multiple managers are configured, the <ref column="target"/>
3776 values must be unique. Duplicate <ref column="target"/> values yield
3777 unspecified results.</p>
3780 <column name="connection_mode">
3782 If it is specified, this setting must be one of the following strings
3783 that describes how Open vSwitch contacts this OVSDB client over the
3788 <dt><code>in-band</code></dt>
3790 In this mode, this connection's traffic travels over a bridge
3791 managed by Open vSwitch. With this setting, Open vSwitch allows
3792 traffic to and from the client regardless of the contents of the
3793 OpenFlow flow table. (Otherwise, Open vSwitch would never be able
3794 to connect to the client, because it did not have a flow to enable
3795 it.) This is the most common connection mode because it is not
3796 necessary to maintain two independent networks.
3798 <dt><code>out-of-band</code></dt>
3800 In this mode, the client's traffic uses a control network separate
3801 from that managed by Open vSwitch, that is, Open vSwitch does not
3802 use any of its own network devices to communicate with the client.
3803 The control network must be configured separately, before or after
3804 <code>ovs-vswitchd</code> is started.
3809 If not specified, the default is implementation-specific.
3814 <group title="Client Failure Detection and Handling">
3815 <column name="max_backoff">
3816 Maximum number of milliseconds to wait between connection attempts.
3817 Default is implementation-specific.
3820 <column name="inactivity_probe">
3821 Maximum number of milliseconds of idle time on connection to the client
3822 before sending an inactivity probe message. If Open vSwitch does not
3823 communicate with the client for the specified number of seconds, it
3824 will send a probe. If a response is not received for the same
3825 additional amount of time, Open vSwitch assumes the connection has been
3826 broken and attempts to reconnect. Default is implementation-specific.
3827 A value of 0 disables inactivity probes.
3831 <group title="Status">
3832 <column name="is_connected">
3833 <code>true</code> if currently connected to this manager,
3834 <code>false</code> otherwise.
3837 <column name="status" key="last_error">
3838 A human-readable description of the last error on the connection
3839 to the manager; i.e. <code>strerror(errno)</code>. This key
3840 will exist only if an error has occurred.
3843 <column name="status" key="state"
3844 type='{"type": "string", "enum": ["set", ["VOID", "BACKOFF", "CONNECTING", "ACTIVE", "IDLE"]]}'>
3846 The state of the connection to the manager:
3849 <dt><code>VOID</code></dt>
3850 <dd>Connection is disabled.</dd>
3852 <dt><code>BACKOFF</code></dt>
3853 <dd>Attempting to reconnect at an increasing period.</dd>
3855 <dt><code>CONNECTING</code></dt>
3856 <dd>Attempting to connect.</dd>
3858 <dt><code>ACTIVE</code></dt>
3859 <dd>Connected, remote host responsive.</dd>
3861 <dt><code>IDLE</code></dt>
3862 <dd>Connection is idle. Waiting for response to keep-alive.</dd>
3865 These values may change in the future. They are provided only for
3870 <column name="status" key="sec_since_connect"
3871 type='{"type": "integer", "minInteger": 0}'>
3872 The amount of time since this manager last successfully connected
3873 to the database (in seconds). Value is empty if manager has never
3874 successfully connected.
3877 <column name="status" key="sec_since_disconnect"
3878 type='{"type": "integer", "minInteger": 0}'>
3879 The amount of time since this manager last disconnected from the
3880 database (in seconds). Value is empty if manager has never
3884 <column name="status" key="locks_held">
3885 Space-separated list of the names of OVSDB locks that the connection
3886 holds. Omitted if the connection does not hold any locks.
3889 <column name="status" key="locks_waiting">
3890 Space-separated list of the names of OVSDB locks that the connection is
3891 currently waiting to acquire. Omitted if the connection is not waiting
3895 <column name="status" key="locks_lost">
3896 Space-separated list of the names of OVSDB locks that the connection
3897 has had stolen by another OVSDB client. Omitted if no locks have been
3898 stolen from this connection.
3901 <column name="status" key="n_connections"
3902 type='{"type": "integer", "minInteger": 2}'>
3904 When <ref column="target"/> specifies a connection method that
3905 listens for inbound connections (e.g. <code>ptcp:</code> or
3906 <code>pssl:</code>) and more than one connection is actually active,
3907 the value is the number of active connections. Otherwise, this
3908 key-value pair is omitted.
3911 When multiple connections are active, status columns and key-value
3912 pairs (other than this one) report the status of one arbitrarily
3917 <column name="status" key="bound_port" type='{"type": "integer"}'>
3918 When <ref column="target"/> is <code>ptcp:</code> or
3919 <code>pssl:</code>, this is the TCP port on which the OVSDB server is
3920 listening. (This is is particularly useful when <ref
3921 column="target"/> specifies a port of 0, allowing the kernel to
3922 choose any available port.)
3926 <group title="Connection Parameters">
3928 Additional configuration for a connection between the manager
3929 and the Open vSwitch Database.
3932 <column name="other_config" key="dscp"
3933 type='{"type": "integer"}'>
3934 The Differentiated Service Code Point (DSCP) is specified using 6 bits
3935 in the Type of Service (TOS) field in the IP header. DSCP provides a
3936 mechanism to classify the network traffic and provide Quality of
3937 Service (QoS) on IP networks.
3939 The DSCP value specified here is used when establishing the connection
3940 between the manager and the Open vSwitch. If no value is specified, a
3941 default value of 48 is chosen. Valid DSCP values must be in the range
3946 <group title="Common Columns">
3947 The overall purpose of these columns is described under <code>Common
3948 Columns</code> at the beginning of this document.
3950 <column name="external_ids"/>
3951 <column name="other_config"/>
3955 <table name="NetFlow">
3956 A NetFlow target. NetFlow is a protocol that exports a number of
3957 details about terminating IP flows, such as the principals involved
3960 <column name="targets">
3961 NetFlow targets in the form
3962 <code><var>ip</var>:<var>port</var></code>. The <var>ip</var>
3963 must be specified numerically, not as a DNS name.
3966 <column name="engine_id">
3967 Engine ID to use in NetFlow messages. Defaults to datapath index
3971 <column name="engine_type">
3972 Engine type to use in NetFlow messages. Defaults to datapath
3973 index if not specified.
3976 <column name="active_timeout">
3977 The interval at which NetFlow records are sent for flows that are
3978 still active, in seconds. A value of <code>0</code> requests the
3979 default timeout (currently 600 seconds); a value of <code>-1</code>
3980 disables active timeouts.
3983 <column name="add_id_to_interface">
3984 <p>If this column's value is <code>false</code>, the ingress and egress
3985 interface fields of NetFlow flow records are derived from OpenFlow port
3986 numbers. When it is <code>true</code>, the 7 most significant bits of
3987 these fields will be replaced by the least significant 7 bits of the
3988 engine id. This is useful because many NetFlow collectors do not
3989 expect multiple switches to be sending messages from the same host, so
3990 they do not store the engine information which could be used to
3991 disambiguate the traffic.</p>
3992 <p>When this option is enabled, a maximum of 508 ports are supported.</p>
3995 <group title="Common Columns">
3996 The overall purpose of these columns is described under <code>Common
3997 Columns</code> at the beginning of this document.
3999 <column name="external_ids"/>
4004 SSL configuration for an Open_vSwitch.
4006 <column name="private_key">
4007 Name of a PEM file containing the private key used as the switch's
4008 identity for SSL connections to the controller.
4011 <column name="certificate">
4012 Name of a PEM file containing a certificate, signed by the
4013 certificate authority (CA) used by the controller and manager,
4014 that certifies the switch's private key, identifying a trustworthy
4018 <column name="ca_cert">
4019 Name of a PEM file containing the CA certificate used to verify
4020 that the switch is connected to a trustworthy controller.
4023 <column name="bootstrap_ca_cert">
4024 If set to <code>true</code>, then Open vSwitch will attempt to
4025 obtain the CA certificate from the controller on its first SSL
4026 connection and save it to the named PEM file. If it is successful,
4027 it will immediately drop the connection and reconnect, and from then
4028 on all SSL connections must be authenticated by a certificate signed
4029 by the CA certificate thus obtained. <em>This option exposes the
4030 SSL connection to a man-in-the-middle attack obtaining the initial
4031 CA certificate.</em> It may still be useful for bootstrapping.
4034 <group title="Common Columns">
4035 The overall purpose of these columns is described under <code>Common
4036 Columns</code> at the beginning of this document.
4038 <column name="external_ids"/>
4042 <table name="sFlow">
4043 <p>A set of sFlow(R) targets. sFlow is a protocol for remote
4044 monitoring of switches.</p>
4046 <column name="agent">
4047 Name of the network device whose IP address should be reported as the
4048 ``agent address'' to collectors. If not specified, the agent device is
4049 figured from the first target address and the routing table. If the
4050 routing table does not contain a route to the target, the IP address
4051 defaults to the <ref table="Controller" column="local_ip"/> in the
4052 collector's <ref table="Controller"/>. If an agent IP address cannot be
4053 determined any of these ways, sFlow is disabled.
4056 <column name="header">
4057 Number of bytes of a sampled packet to send to the collector.
4058 If not specified, the default is 128 bytes.
4061 <column name="polling">
4062 Polling rate in seconds to send port statistics to the collector.
4063 If not specified, defaults to 30 seconds.
4066 <column name="sampling">
4067 Rate at which packets should be sampled and sent to the collector.
4068 If not specified, defaults to 400, which means one out of 400
4069 packets, on average, will be sent to the collector.
4072 <column name="targets">
4073 sFlow targets in the form
4074 <code><var>ip</var>:<var>port</var></code>.
4077 <group title="Common Columns">
4078 The overall purpose of these columns is described under <code>Common
4079 Columns</code> at the beginning of this document.
4081 <column name="external_ids"/>
4085 <table name="IPFIX">
4086 <p>A set of IPFIX collectors. IPFIX is a protocol that exports a
4087 number of details about flows.</p>
4089 <column name="targets">
4090 IPFIX target collectors in the form
4091 <code><var>ip</var>:<var>port</var></code>.
4094 <column name="sampling">
4095 For per-bridge packet sampling, i.e. when this row is referenced
4096 from a <ref table="Bridge"/>, the rate at which packets should
4097 be sampled and sent to each target collector. If not specified,
4098 defaults to 400, which means one out of 400 packets, on average,
4099 will be sent to each target collector. Ignored for per-flow
4100 sampling, i.e. when this row is referenced from a <ref
4101 table="Flow_Sample_Collector_Set"/>.
4104 <column name="obs_domain_id">
4105 For per-bridge packet sampling, i.e. when this row is referenced
4106 from a <ref table="Bridge"/>, the IPFIX Observation Domain ID
4107 sent in each IPFIX packet. If not specified, defaults to 0.
4108 Ignored for per-flow sampling, i.e. when this row is referenced
4109 from a <ref table="Flow_Sample_Collector_Set"/>.
4112 <column name="obs_point_id">
4113 For per-bridge packet sampling, i.e. when this row is referenced
4114 from a <ref table="Bridge"/>, the IPFIX Observation Point ID
4115 sent in each IPFIX flow record. If not specified, defaults to
4116 0. Ignored for per-flow sampling, i.e. when this row is
4117 referenced from a <ref table="Flow_Sample_Collector_Set"/>.
4120 <column name="cache_active_timeout">
4121 The maximum period in seconds for which an IPFIX flow record is
4122 cached and aggregated before being sent. If not specified,
4123 defaults to 0. If 0, caching is disabled.
4126 <column name="cache_max_flows">
4127 The maximum number of IPFIX flow records that can be cached at a
4128 time. If not specified, defaults to 0. If 0, caching is
4132 <column name="other_config" key="enable-tunnel-sampling"
4133 type='{"type": "boolean"}'>
4134 <p>For per-bridge packet sampling, i.e. when this row is referenced
4135 from a <ref table="Bridge"/>, enable sampling and reporting tunnel
4136 header 7-tuples in IPFIX flow records. Disabled by default.
4137 Ignored for per-flow sampling, i.e. when this row is referenced
4138 from a <ref table="Flow_Sample_Collector_Set"/>.</p>
4139 <p><em>Please note:</em> The following enterprise entities are
4140 currently used when exporting the sampled tunnel info.</p>
4142 <dt>tunnelType:</dt>
4144 <p>ID: 891, and enterprise ID 6876 (VMware).</p>
4145 <p>type: unsigned 8-bit interger.</p>
4146 <p>data type semantics: identifier.</p>
4147 <p>description: Identifier of the layer 2 network overlay network
4148 encapsulation type: 0x01 VxLAN, 0x02 GRE, 0x03 LISP, 0x05 IPsec+GRE,
4153 <p>ID: 892, and enterprise ID 6876 (VMware).</p>
4154 <p>type: variable-length octetarray.</p>
4155 <p>data type semantics: identifier.</p>
4156 <p>description: Key which is used for identifying an individual
4157 traffic flow within a VxLAN (24-bit VNI), GENEVE(24-bit VNI),
4158 GRE (32- or 64-bit key), or LISP (24-bit instance ID) tunnel. The
4159 key is encoded in this octetarray as a 3-, 4-, or 8-byte integer
4160 ID in network byte order.</p>
4162 <dt>tunnelSourceIPv4Address:</dt>
4164 <p>ID: 893, and enterprise ID 6876 (VMware).</p>
4165 <p>type: unsigned 32-bit interger.</p>
4166 <p>data type semantics: identifier.</p>
4167 <p>description: The IPv4 source address in the tunnel IP packet
4170 <dt>tunnelDestinationIPv4Address:</dt>
4172 <p>ID: 894, and enterprise ID 6876 (VMware).</p>
4173 <p>type: unsigned 32-bit integer.</p>
4174 <p>data type semantics: identifier.</p>
4175 <p>description: The IPv4 destination address in the tunnel IP
4178 <dt>tunnelProtocolIdentifier:</dt>
4180 <p>ID: 895, and enterprise ID 6876 (VMware).</p>
4181 <p>type: unsigned 8-bit integer.</p>
4182 <p>data type semantics: identifier.</p>
4183 <p>description: The value of the protocol number in the tunnel
4184 IP packet header. The protocol number identifies the tunnel IP
4185 packet payload type.</p>
4187 <dt>tunnelSourceTransportPort:</dt>
4189 <p>ID: 896, and enterprise ID 6876 (VMware).</p>
4190 <p>type: unsigned 16-bit integer.</p>
4191 <p>data type semantics: identifier.</p>
4192 <p>description: The source port identifier in the tunnel transport
4193 header. For the transport protocols UDP, TCP, and SCTP, this is
4194 the source port number given in the respective header.</p>
4196 <dt>tunnelDestinationTransportPort:</dt>
4198 <p>ID: 897, and enterprise ID 6876 (VMware).</p>
4199 <p>type: unsigned 16-bit integer.</p>
4200 <p>data type semantics: identifier.</p>
4201 <p>description: The destination port identifier in the tunnel
4202 transport header. For the transport protocols UDP, TCP, and SCTP,
4203 this is the destination port number given in the respective header.
4209 <column name="other_config" key="enable-input-sampling"
4210 type='{"type": "boolean"}'>
4211 For per-bridge packet sampling, i.e. when this row is referenced
4212 from a <ref table="Bridge"/>, enable sampling and reporting flows
4213 at bridge port input in IPFIX flow records. Enabled by default.
4214 Ignored for per-flow sampling, i.e. when this row is referenced
4215 from a <ref table="Flow_Sample_Collector_Set"/>.
4218 <column name="other_config" key="enable-output-sampling"
4219 type='{"type": "boolean"}'>
4220 For per-bridge packet sampling, i.e. when this row is referenced
4221 from a <ref table="Bridge"/>, enable sampling and reporting flows
4222 at bridge port output in IPFIX flow records. Enabled by default.
4223 Ignored for per-flow sampling, i.e. when this row is referenced
4224 from a <ref table="Flow_Sample_Collector_Set"/>.
4227 <group title="Common Columns">
4228 The overall purpose of these columns is described under <code>Common
4229 Columns</code> at the beginning of this document.
4231 <column name="external_ids"/>
4235 <table name="Flow_Sample_Collector_Set">
4236 <p>A set of IPFIX collectors of packet samples generated by
4237 OpenFlow <code>sample</code> actions.</p>
4240 The ID of this collector set, unique among the bridge's
4241 collector sets, to be used as the <code>collector_set_id</code>
4242 in OpenFlow <code>sample</code> actions.
4245 <column name="bridge">
4246 The bridge into which OpenFlow <code>sample</code> actions can
4247 be added to send packet samples to this set of IPFIX collectors.
4250 <column name="ipfix">
4251 Configuration of the set of IPFIX collectors to send one flow
4252 record per sampled packet to.
4255 <group title="Common Columns">
4256 The overall purpose of these columns is described under <code>Common
4257 Columns</code> at the beginning of this document.
4259 <column name="external_ids"/>